@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/accountterminalapplications/README.md DELETED
@@ -1,371 +0,0 @@
1
- # AccountTerminalApplications
2
- (*accountTerminalApplications*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [link](#link) - Link an account with a terminal application.
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}/terminal-applications.write` scope.
12
- * [list](#list) - Retrieve all terminal applications linked to a specific 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}/terminal-applications.read` scope.
16
- * [get](#get) - Verifies if a specific Terminal Application is linked to an Account. This endpoint acts as a validation check for the link's existence.
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}/terminal-applications.read` scope.
20
- * [getConfiguration](#getconfiguration) - Fetch the configuration for a given Terminal Application linked to a specific 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}/terminal-configuration.read` scope.
24
-
25
- ## link
26
-
27
- Link an account with a terminal application.
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}/terminal-applications.write` scope.
31
-
32
- ### Example Usage
33
-
34
- <!-- UsageSnippet language="typescript" operationID="linkAccountTerminalApplication" method="post" path="/accounts/{accountID}/terminal-applications" -->
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.accountTerminalApplications.link({
48
- accountID: "76d4c8a0-1f2b-4e3b-8f5c-7a9e1b2c3d4e",
49
- linkAccountTerminalApplication: {
50
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
51
- },
52
- });
53
-
54
- console.log(result);
55
- }
56
-
57
- run();
58
- ```
59
-
60
- ### Standalone function
61
-
62
- The standalone function version of this method:
63
-
64
- ```typescript
65
- import { MoovCore } from "@moovio/sdk/core.js";
66
- import { accountTerminalApplicationsLink } from "@moovio/sdk/funcs/accountTerminalApplicationsLink.js";
67
-
68
- // Use `MoovCore` for best tree-shaking performance.
69
- // You can create one instance of it to use across an application.
70
- const moov = new MoovCore({
71
- xMoovVersion: "v2024.01.00",
72
- security: {
73
- username: "",
74
- password: "",
75
- },
76
- });
77
-
78
- async function run() {
79
- const res = await accountTerminalApplicationsLink(moov, {
80
- accountID: "76d4c8a0-1f2b-4e3b-8f5c-7a9e1b2c3d4e",
81
- linkAccountTerminalApplication: {
82
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
83
- },
84
- });
85
- if (res.ok) {
86
- const { value: result } = res;
87
- console.log(result);
88
- } else {
89
- console.log("accountTerminalApplicationsLink failed:", res.error);
90
- }
91
- }
92
-
93
- run();
94
- ```
95
-
96
- ### Parameters
97
-
98
- | Parameter | Type | Required | Description |
99
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
100
- | `request` | [operations.LinkAccountTerminalApplicationRequest](../../models/operations/linkaccountterminalapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
101
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
102
- | `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. |
103
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
104
-
105
- ### Response
106
-
107
- **Promise\<[operations.LinkAccountTerminalApplicationResponse](../../models/operations/linkaccountterminalapplicationresponse.md)\>**
108
-
109
- ### Errors
110
-
111
- | Error Type | Status Code | Content Type |
112
- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
113
- | errors.GenericError | 400, 409 | application/json |
114
- | errors.AccountTerminalApplicationError | 422 | application/json |
115
- | errors.APIError | 4XX, 5XX | \*/\* |
116
-
117
- ## list
118
-
119
- Retrieve all terminal applications linked to a specific account.
120
-
121
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
122
- you'll need to specify the `/accounts/{accountID}/terminal-applications.read` scope.
123
-
124
- ### Example Usage
125
-
126
- <!-- UsageSnippet language="typescript" operationID="listAccountTerminalApplications" method="get" path="/accounts/{accountID}/terminal-applications" -->
127
- ```typescript
128
- import { Moov } from "@moovio/sdk";
129
-
130
- const moov = new Moov({
131
- xMoovVersion: "v2024.01.00",
132
- security: {
133
- username: "",
134
- password: "",
135
- },
136
- });
137
-
138
- async function run() {
139
- const result = await moov.accountTerminalApplications.list({
140
- accountID: "76d4c8a0-1f2b-4e3b-8f5c-7a9e1b2c3d4e",
141
- });
142
-
143
- console.log(result);
144
- }
145
-
146
- run();
147
- ```
148
-
149
- ### Standalone function
150
-
151
- The standalone function version of this method:
152
-
153
- ```typescript
154
- import { MoovCore } from "@moovio/sdk/core.js";
155
- import { accountTerminalApplicationsList } from "@moovio/sdk/funcs/accountTerminalApplicationsList.js";
156
-
157
- // Use `MoovCore` for best tree-shaking performance.
158
- // You can create one instance of it to use across an application.
159
- const moov = new MoovCore({
160
- xMoovVersion: "v2024.01.00",
161
- security: {
162
- username: "",
163
- password: "",
164
- },
165
- });
166
-
167
- async function run() {
168
- const res = await accountTerminalApplicationsList(moov, {
169
- accountID: "76d4c8a0-1f2b-4e3b-8f5c-7a9e1b2c3d4e",
170
- });
171
- if (res.ok) {
172
- const { value: result } = res;
173
- console.log(result);
174
- } else {
175
- console.log("accountTerminalApplicationsList failed:", res.error);
176
- }
177
- }
178
-
179
- run();
180
- ```
181
-
182
- ### Parameters
183
-
184
- | Parameter | Type | Required | Description |
185
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
186
- | `request` | [operations.ListAccountTerminalApplicationsRequest](../../models/operations/listaccountterminalapplicationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
187
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
188
- | `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. |
189
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
190
-
191
- ### Response
192
-
193
- **Promise\<[operations.ListAccountTerminalApplicationsResponse](../../models/operations/listaccountterminalapplicationsresponse.md)\>**
194
-
195
- ### Errors
196
-
197
- | Error Type | Status Code | Content Type |
198
- | --------------- | --------------- | --------------- |
199
- | errors.APIError | 4XX, 5XX | \*/\* |
200
-
201
- ## get
202
-
203
- Verifies if a specific Terminal Application is linked to an Account. This endpoint acts as a validation check for the link's existence.
204
-
205
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
206
- you'll need to specify the `/accounts/{accountID}/terminal-applications.read` scope.
207
-
208
- ### Example Usage
209
-
210
- <!-- UsageSnippet language="typescript" operationID="getAccountTerminalApplication" method="get" path="/accounts/{accountID}/terminal-applications/{terminalApplicationID}" -->
211
- ```typescript
212
- import { Moov } from "@moovio/sdk";
213
-
214
- const moov = new Moov({
215
- xMoovVersion: "v2024.01.00",
216
- security: {
217
- username: "",
218
- password: "",
219
- },
220
- });
221
-
222
- async function run() {
223
- const result = await moov.accountTerminalApplications.get({
224
- accountID: "76d4c8a0-1f2b-4e3b-8f5c-7a9e1b2c3d4e",
225
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
226
- });
227
-
228
- console.log(result);
229
- }
230
-
231
- run();
232
- ```
233
-
234
- ### Standalone function
235
-
236
- The standalone function version of this method:
237
-
238
- ```typescript
239
- import { MoovCore } from "@moovio/sdk/core.js";
240
- import { accountTerminalApplicationsGet } from "@moovio/sdk/funcs/accountTerminalApplicationsGet.js";
241
-
242
- // Use `MoovCore` for best tree-shaking performance.
243
- // You can create one instance of it to use across an application.
244
- const moov = new MoovCore({
245
- xMoovVersion: "v2024.01.00",
246
- security: {
247
- username: "",
248
- password: "",
249
- },
250
- });
251
-
252
- async function run() {
253
- const res = await accountTerminalApplicationsGet(moov, {
254
- accountID: "76d4c8a0-1f2b-4e3b-8f5c-7a9e1b2c3d4e",
255
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
256
- });
257
- if (res.ok) {
258
- const { value: result } = res;
259
- console.log(result);
260
- } else {
261
- console.log("accountTerminalApplicationsGet failed:", res.error);
262
- }
263
- }
264
-
265
- run();
266
- ```
267
-
268
- ### Parameters
269
-
270
- | Parameter | Type | Required | Description |
271
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
272
- | `request` | [operations.GetAccountTerminalApplicationRequest](../../models/operations/getaccountterminalapplicationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
273
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
274
- | `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. |
275
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
276
-
277
- ### Response
278
-
279
- **Promise\<[operations.GetAccountTerminalApplicationResponse](../../models/operations/getaccountterminalapplicationresponse.md)\>**
280
-
281
- ### Errors
282
-
283
- | Error Type | Status Code | Content Type |
284
- | --------------- | --------------- | --------------- |
285
- | errors.APIError | 4XX, 5XX | \*/\* |
286
-
287
- ## getConfiguration
288
-
289
- Fetch the configuration for a given Terminal Application linked to a specific Account.
290
-
291
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
292
- you'll need to specify the `/accounts/{accountID}/terminal-configuration.read` scope.
293
-
294
- ### Example Usage
295
-
296
- <!-- UsageSnippet language="typescript" operationID="getTerminalConfiguration" method="get" path="/accounts/{accountID}/terminal-applications/{terminalApplicationID}/configuration" -->
297
- ```typescript
298
- import { Moov } from "@moovio/sdk";
299
-
300
- const moov = new Moov({
301
- xMoovVersion: "v2024.01.00",
302
- security: {
303
- username: "",
304
- password: "",
305
- },
306
- });
307
-
308
- async function run() {
309
- const result = await moov.accountTerminalApplications.getConfiguration({
310
- accountID: "76d4c8a0-1f2b-4e3b-8f5c-7a9e1b2c3d4e",
311
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
312
- });
313
-
314
- console.log(result);
315
- }
316
-
317
- run();
318
- ```
319
-
320
- ### Standalone function
321
-
322
- The standalone function version of this method:
323
-
324
- ```typescript
325
- import { MoovCore } from "@moovio/sdk/core.js";
326
- import { accountTerminalApplicationsGetConfiguration } from "@moovio/sdk/funcs/accountTerminalApplicationsGetConfiguration.js";
327
-
328
- // Use `MoovCore` for best tree-shaking performance.
329
- // You can create one instance of it to use across an application.
330
- const moov = new MoovCore({
331
- xMoovVersion: "v2024.01.00",
332
- security: {
333
- username: "",
334
- password: "",
335
- },
336
- });
337
-
338
- async function run() {
339
- const res = await accountTerminalApplicationsGetConfiguration(moov, {
340
- accountID: "76d4c8a0-1f2b-4e3b-8f5c-7a9e1b2c3d4e",
341
- terminalApplicationID: "12345678-1234-1234-1234-123456789012",
342
- });
343
- if (res.ok) {
344
- const { value: result } = res;
345
- console.log(result);
346
- } else {
347
- console.log("accountTerminalApplicationsGetConfiguration failed:", res.error);
348
- }
349
- }
350
-
351
- run();
352
- ```
353
-
354
- ### Parameters
355
-
356
- | Parameter | Type | Required | Description |
357
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
358
- | `request` | [operations.GetTerminalConfigurationRequest](../../models/operations/getterminalconfigurationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
359
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
360
- | `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. |
361
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
362
-
363
- ### Response
364
-
365
- **Promise\<[operations.GetTerminalConfigurationResponse](../../models/operations/getterminalconfigurationresponse.md)\>**
366
-
367
- ### Errors
368
-
369
- | Error Type | Status Code | Content Type |
370
- | --------------- | --------------- | --------------- |
371
- | errors.APIError | 4XX, 5XX | \*/\* |
package/docs/sdks/adjustments/README.md DELETED
@@ -1,185 +0,0 @@
1
- # Adjustments
2
- (*adjustments*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - List adjustments associated with a Moov 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}/wallets.read` scope.
12
- * [get](#get) - Retrieve a specific adjustment associated with a Moov 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}/wallets.read` scope.
16
-
17
- ## list
18
-
19
- List adjustments associated with a Moov account.
20
-
21
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
22
- you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
23
-
24
- ### Example Usage
25
-
26
- <!-- UsageSnippet language="typescript" operationID="listAdjustments" method="get" path="/accounts/{accountID}/adjustments" -->
27
- ```typescript
28
- import { Moov } from "@moovio/sdk";
29
-
30
- const moov = new Moov({
31
- xMoovVersion: "v2024.01.00",
32
- security: {
33
- username: "",
34
- password: "",
35
- },
36
- });
37
-
38
- async function run() {
39
- const result = await moov.adjustments.list({
40
- accountID: "c054f3a6-d542-4310-a955-830739f800f0",
41
- });
42
-
43
- console.log(result);
44
- }
45
-
46
- run();
47
- ```
48
-
49
- ### Standalone function
50
-
51
- The standalone function version of this method:
52
-
53
- ```typescript
54
- import { MoovCore } from "@moovio/sdk/core.js";
55
- import { adjustmentsList } from "@moovio/sdk/funcs/adjustmentsList.js";
56
-
57
- // Use `MoovCore` for best tree-shaking performance.
58
- // You can create one instance of it to use across an application.
59
- const moov = new MoovCore({
60
- xMoovVersion: "v2024.01.00",
61
- security: {
62
- username: "",
63
- password: "",
64
- },
65
- });
66
-
67
- async function run() {
68
- const res = await adjustmentsList(moov, {
69
- accountID: "c054f3a6-d542-4310-a955-830739f800f0",
70
- });
71
- if (res.ok) {
72
- const { value: result } = res;
73
- console.log(result);
74
- } else {
75
- console.log("adjustmentsList failed:", res.error);
76
- }
77
- }
78
-
79
- run();
80
- ```
81
-
82
- ### Parameters
83
-
84
- | Parameter | Type | Required | Description |
85
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
86
- | `request` | [operations.ListAdjustmentsRequest](../../models/operations/listadjustmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
87
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
88
- | `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. |
89
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
90
-
91
- ### Response
92
-
93
- **Promise\<[operations.ListAdjustmentsResponse](../../models/operations/listadjustmentsresponse.md)\>**
94
-
95
- ### Errors
96
-
97
- | Error Type | Status Code | Content Type |
98
- | --------------- | --------------- | --------------- |
99
- | errors.APIError | 4XX, 5XX | \*/\* |
100
-
101
- ## get
102
-
103
- Retrieve a specific adjustment associated with a Moov account.
104
-
105
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
106
- you'll need to specify the `/accounts/{accountID}/wallets.read` scope.
107
-
108
- ### Example Usage
109
-
110
- <!-- UsageSnippet language="typescript" operationID="getAdjustment" method="get" path="/accounts/{accountID}/adjustments/{adjustmentID}" -->
111
- ```typescript
112
- import { Moov } from "@moovio/sdk";
113
-
114
- const moov = new Moov({
115
- xMoovVersion: "v2024.01.00",
116
- security: {
117
- username: "",
118
- password: "",
119
- },
120
- });
121
-
122
- async function run() {
123
- const result = await moov.adjustments.get({
124
- accountID: "3ef4e658-8aaa-449f-a7a4-95a6839172a1",
125
- adjustmentID: "cbe4a8e7-605f-4667-a308-1afde85cd7a5",
126
- });
127
-
128
- console.log(result);
129
- }
130
-
131
- run();
132
- ```
133
-
134
- ### Standalone function
135
-
136
- The standalone function version of this method:
137
-
138
- ```typescript
139
- import { MoovCore } from "@moovio/sdk/core.js";
140
- import { adjustmentsGet } from "@moovio/sdk/funcs/adjustmentsGet.js";
141
-
142
- // Use `MoovCore` for best tree-shaking performance.
143
- // You can create one instance of it to use across an application.
144
- const moov = new MoovCore({
145
- xMoovVersion: "v2024.01.00",
146
- security: {
147
- username: "",
148
- password: "",
149
- },
150
- });
151
-
152
- async function run() {
153
- const res = await adjustmentsGet(moov, {
154
- accountID: "3ef4e658-8aaa-449f-a7a4-95a6839172a1",
155
- adjustmentID: "cbe4a8e7-605f-4667-a308-1afde85cd7a5",
156
- });
157
- if (res.ok) {
158
- const { value: result } = res;
159
- console.log(result);
160
- } else {
161
- console.log("adjustmentsGet failed:", res.error);
162
- }
163
- }
164
-
165
- run();
166
- ```
167
-
168
- ### Parameters
169
-
170
- | Parameter | Type | Required | Description |
171
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
172
- | `request` | [operations.GetAdjustmentRequest](../../models/operations/getadjustmentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
173
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
174
- | `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. |
175
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
176
-
177
- ### Response
178
-
179
- **Promise\<[operations.GetAdjustmentResponse](../../models/operations/getadjustmentresponse.md)\>**
180
-
181
- ### Errors
182
-
183
- | Error Type | Status Code | Content Type |
184
- | --------------- | --------------- | --------------- |
185
- | errors.APIError | 4XX, 5XX | \*/\* |