@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/issuingtransactions/README.md DELETED
@@ -1,465 +0,0 @@
1
- # IssuingTransactions
2
- (*issuingTransactions*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [listAuthorizations](#listauthorizations) - List issued card authorizations 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}/issued-cards.read` scope.
12
- * [getAuthorization](#getauthorization) - Retrieves details of an authorization associated with a specific 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}/issued-cards.read` scope.
16
- * [listAuthorizationEvents](#listauthorizationevents) - List card network and Moov platform events that affect the authorization and its hold on a wallet balance.
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}/issued-cards.read` scope.
20
- * [list](#list) - List issued card transactions associated with a Moov 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}/issued-cards.read` scope.
24
- * [get](#get) - Retrieves details of an issued card transaction associated with a specific Moov account.
25
-
26
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
27
- you'll need to specify the `/accounts/{accountID}/issued-cards.read` scope.
28
-
29
- ## listAuthorizations
30
-
31
- List issued card authorizations associated with a Moov account.
32
-
33
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
34
- you'll need to specify the `/accounts/{accountID}/issued-cards.read` scope.
35
-
36
- ### Example Usage
37
-
38
- <!-- UsageSnippet language="typescript" operationID="listIssuedCardAuthorizations" method="get" path="/issuing/{accountID}/authorizations" -->
39
- ```typescript
40
- import { Moov } from "@moovio/sdk";
41
-
42
- const moov = new Moov({
43
- xMoovVersion: "v2024.01.00",
44
- security: {
45
- username: "",
46
- password: "",
47
- },
48
- });
49
-
50
- async function run() {
51
- const result = await moov.issuingTransactions.listAuthorizations({
52
- accountID: "6465d95a-e945-4a49-8983-d74faa135bb4",
53
- skip: 60,
54
- count: 20,
55
- });
56
-
57
- console.log(result);
58
- }
59
-
60
- run();
61
- ```
62
-
63
- ### Standalone function
64
-
65
- The standalone function version of this method:
66
-
67
- ```typescript
68
- import { MoovCore } from "@moovio/sdk/core.js";
69
- import { issuingTransactionsListAuthorizations } from "@moovio/sdk/funcs/issuingTransactionsListAuthorizations.js";
70
-
71
- // Use `MoovCore` for best tree-shaking performance.
72
- // You can create one instance of it to use across an application.
73
- const moov = new MoovCore({
74
- xMoovVersion: "v2024.01.00",
75
- security: {
76
- username: "",
77
- password: "",
78
- },
79
- });
80
-
81
- async function run() {
82
- const res = await issuingTransactionsListAuthorizations(moov, {
83
- accountID: "6465d95a-e945-4a49-8983-d74faa135bb4",
84
- skip: 60,
85
- count: 20,
86
- });
87
- if (res.ok) {
88
- const { value: result } = res;
89
- console.log(result);
90
- } else {
91
- console.log("issuingTransactionsListAuthorizations failed:", res.error);
92
- }
93
- }
94
-
95
- run();
96
- ```
97
-
98
- ### Parameters
99
-
100
- | Parameter | Type | Required | Description |
101
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
102
- | `request` | [operations.ListIssuedCardAuthorizationsRequest](../../models/operations/listissuedcardauthorizationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
103
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
104
- | `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. |
105
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
106
-
107
- ### Response
108
-
109
- **Promise\<[operations.ListIssuedCardAuthorizationsResponse](../../models/operations/listissuedcardauthorizationsresponse.md)\>**
110
-
111
- ### Errors
112
-
113
- | Error Type | Status Code | Content Type |
114
- | --------------- | --------------- | --------------- |
115
- | errors.APIError | 4XX, 5XX | \*/\* |
116
-
117
- ## getAuthorization
118
-
119
- Retrieves details of an authorization associated with a specific Moov 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}/issued-cards.read` scope.
123
-
124
- ### Example Usage
125
-
126
- <!-- UsageSnippet language="typescript" operationID="getIssuedCardAuthorization" method="get" path="/issuing/{accountID}/authorizations/{authorizationID}" -->
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.issuingTransactions.getAuthorization({
140
- accountID: "0ccac2cc-6692-44a9-b0d1-35a1892c2db2",
141
- authorizationID: "d9ee8dde-b1eb-492f-bea1-d8e09bccbc52",
142
- });
143
-
144
- console.log(result);
145
- }
146
-
147
- run();
148
- ```
149
-
150
- ### Standalone function
151
-
152
- The standalone function version of this method:
153
-
154
- ```typescript
155
- import { MoovCore } from "@moovio/sdk/core.js";
156
- import { issuingTransactionsGetAuthorization } from "@moovio/sdk/funcs/issuingTransactionsGetAuthorization.js";
157
-
158
- // Use `MoovCore` for best tree-shaking performance.
159
- // You can create one instance of it to use across an application.
160
- const moov = new MoovCore({
161
- xMoovVersion: "v2024.01.00",
162
- security: {
163
- username: "",
164
- password: "",
165
- },
166
- });
167
-
168
- async function run() {
169
- const res = await issuingTransactionsGetAuthorization(moov, {
170
- accountID: "0ccac2cc-6692-44a9-b0d1-35a1892c2db2",
171
- authorizationID: "d9ee8dde-b1eb-492f-bea1-d8e09bccbc52",
172
- });
173
- if (res.ok) {
174
- const { value: result } = res;
175
- console.log(result);
176
- } else {
177
- console.log("issuingTransactionsGetAuthorization failed:", res.error);
178
- }
179
- }
180
-
181
- run();
182
- ```
183
-
184
- ### Parameters
185
-
186
- | Parameter | Type | Required | Description |
187
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
188
- | `request` | [operations.GetIssuedCardAuthorizationRequest](../../models/operations/getissuedcardauthorizationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
189
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
190
- | `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. |
191
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
192
-
193
- ### Response
194
-
195
- **Promise\<[operations.GetIssuedCardAuthorizationResponse](../../models/operations/getissuedcardauthorizationresponse.md)\>**
196
-
197
- ### Errors
198
-
199
- | Error Type | Status Code | Content Type |
200
- | --------------- | --------------- | --------------- |
201
- | errors.APIError | 4XX, 5XX | \*/\* |
202
-
203
- ## listAuthorizationEvents
204
-
205
- List card network and Moov platform events that affect the authorization and its hold on a wallet balance.
206
-
207
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
208
- you'll need to specify the `/accounts/{accountID}/issued-cards.read` scope.
209
-
210
- ### Example Usage
211
-
212
- <!-- UsageSnippet language="typescript" operationID="listIssuedCardAuthorizationEvents" method="get" path="/issuing/{accountID}/authorizations/{authorizationID}/events" -->
213
- ```typescript
214
- import { Moov } from "@moovio/sdk";
215
-
216
- const moov = new Moov({
217
- xMoovVersion: "v2024.01.00",
218
- security: {
219
- username: "",
220
- password: "",
221
- },
222
- });
223
-
224
- async function run() {
225
- const result = await moov.issuingTransactions.listAuthorizationEvents({
226
- accountID: "f30f8cb3-64d8-4a5f-a427-965317fa559a",
227
- authorizationID: "e6a0946d-f3d8-451e-9b1c-5bc346a95dd6",
228
- skip: 60,
229
- count: 20,
230
- });
231
-
232
- console.log(result);
233
- }
234
-
235
- run();
236
- ```
237
-
238
- ### Standalone function
239
-
240
- The standalone function version of this method:
241
-
242
- ```typescript
243
- import { MoovCore } from "@moovio/sdk/core.js";
244
- import { issuingTransactionsListAuthorizationEvents } from "@moovio/sdk/funcs/issuingTransactionsListAuthorizationEvents.js";
245
-
246
- // Use `MoovCore` for best tree-shaking performance.
247
- // You can create one instance of it to use across an application.
248
- const moov = new MoovCore({
249
- xMoovVersion: "v2024.01.00",
250
- security: {
251
- username: "",
252
- password: "",
253
- },
254
- });
255
-
256
- async function run() {
257
- const res = await issuingTransactionsListAuthorizationEvents(moov, {
258
- accountID: "f30f8cb3-64d8-4a5f-a427-965317fa559a",
259
- authorizationID: "e6a0946d-f3d8-451e-9b1c-5bc346a95dd6",
260
- skip: 60,
261
- count: 20,
262
- });
263
- if (res.ok) {
264
- const { value: result } = res;
265
- console.log(result);
266
- } else {
267
- console.log("issuingTransactionsListAuthorizationEvents failed:", res.error);
268
- }
269
- }
270
-
271
- run();
272
- ```
273
-
274
- ### Parameters
275
-
276
- | Parameter | Type | Required | Description |
277
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
278
- | `request` | [operations.ListIssuedCardAuthorizationEventsRequest](../../models/operations/listissuedcardauthorizationeventsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
279
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
280
- | `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. |
281
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
282
-
283
- ### Response
284
-
285
- **Promise\<[operations.ListIssuedCardAuthorizationEventsResponse](../../models/operations/listissuedcardauthorizationeventsresponse.md)\>**
286
-
287
- ### Errors
288
-
289
- | Error Type | Status Code | Content Type |
290
- | --------------- | --------------- | --------------- |
291
- | errors.APIError | 4XX, 5XX | \*/\* |
292
-
293
- ## list
294
-
295
- List issued card transactions associated with a Moov account.
296
-
297
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
298
- you'll need to specify the `/accounts/{accountID}/issued-cards.read` scope.
299
-
300
- ### Example Usage
301
-
302
- <!-- UsageSnippet language="typescript" operationID="listIssuedCardTransactions" method="get" path="/issuing/{accountID}/card-transactions" -->
303
- ```typescript
304
- import { Moov } from "@moovio/sdk";
305
-
306
- const moov = new Moov({
307
- xMoovVersion: "v2024.01.00",
308
- security: {
309
- username: "",
310
- password: "",
311
- },
312
- });
313
-
314
- async function run() {
315
- const result = await moov.issuingTransactions.list({
316
- accountID: "4efcb497-f915-4b6e-b973-e5e5bcc1fd34",
317
- skip: 60,
318
- count: 20,
319
- });
320
-
321
- console.log(result);
322
- }
323
-
324
- run();
325
- ```
326
-
327
- ### Standalone function
328
-
329
- The standalone function version of this method:
330
-
331
- ```typescript
332
- import { MoovCore } from "@moovio/sdk/core.js";
333
- import { issuingTransactionsList } from "@moovio/sdk/funcs/issuingTransactionsList.js";
334
-
335
- // Use `MoovCore` for best tree-shaking performance.
336
- // You can create one instance of it to use across an application.
337
- const moov = new MoovCore({
338
- xMoovVersion: "v2024.01.00",
339
- security: {
340
- username: "",
341
- password: "",
342
- },
343
- });
344
-
345
- async function run() {
346
- const res = await issuingTransactionsList(moov, {
347
- accountID: "4efcb497-f915-4b6e-b973-e5e5bcc1fd34",
348
- skip: 60,
349
- count: 20,
350
- });
351
- if (res.ok) {
352
- const { value: result } = res;
353
- console.log(result);
354
- } else {
355
- console.log("issuingTransactionsList failed:", res.error);
356
- }
357
- }
358
-
359
- run();
360
- ```
361
-
362
- ### Parameters
363
-
364
- | Parameter | Type | Required | Description |
365
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
366
- | `request` | [operations.ListIssuedCardTransactionsRequest](../../models/operations/listissuedcardtransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
367
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
368
- | `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. |
369
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
370
-
371
- ### Response
372
-
373
- **Promise\<[operations.ListIssuedCardTransactionsResponse](../../models/operations/listissuedcardtransactionsresponse.md)\>**
374
-
375
- ### Errors
376
-
377
- | Error Type | Status Code | Content Type |
378
- | --------------- | --------------- | --------------- |
379
- | errors.APIError | 4XX, 5XX | \*/\* |
380
-
381
- ## get
382
-
383
- Retrieves details of an issued card transaction associated with a specific Moov account.
384
-
385
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
386
- you'll need to specify the `/accounts/{accountID}/issued-cards.read` scope.
387
-
388
- ### Example Usage
389
-
390
- <!-- UsageSnippet language="typescript" operationID="getIssuedCardTransaction" method="get" path="/issuing/{accountID}/card-transactions/{cardTransactionID}" -->
391
- ```typescript
392
- import { Moov } from "@moovio/sdk";
393
-
394
- const moov = new Moov({
395
- xMoovVersion: "v2024.01.00",
396
- security: {
397
- username: "",
398
- password: "",
399
- },
400
- });
401
-
402
- async function run() {
403
- const result = await moov.issuingTransactions.get({
404
- accountID: "b2b6e23c-a5aa-46a9-adb7-d12876e47288",
405
- cardTransactionID: "d5a1aab9-eb96-409a-ab95-88ac99cf00a5",
406
- });
407
-
408
- console.log(result);
409
- }
410
-
411
- run();
412
- ```
413
-
414
- ### Standalone function
415
-
416
- The standalone function version of this method:
417
-
418
- ```typescript
419
- import { MoovCore } from "@moovio/sdk/core.js";
420
- import { issuingTransactionsGet } from "@moovio/sdk/funcs/issuingTransactionsGet.js";
421
-
422
- // Use `MoovCore` for best tree-shaking performance.
423
- // You can create one instance of it to use across an application.
424
- const moov = new MoovCore({
425
- xMoovVersion: "v2024.01.00",
426
- security: {
427
- username: "",
428
- password: "",
429
- },
430
- });
431
-
432
- async function run() {
433
- const res = await issuingTransactionsGet(moov, {
434
- accountID: "b2b6e23c-a5aa-46a9-adb7-d12876e47288",
435
- cardTransactionID: "d5a1aab9-eb96-409a-ab95-88ac99cf00a5",
436
- });
437
- if (res.ok) {
438
- const { value: result } = res;
439
- console.log(result);
440
- } else {
441
- console.log("issuingTransactionsGet failed:", res.error);
442
- }
443
- }
444
-
445
- run();
446
- ```
447
-
448
- ### Parameters
449
-
450
- | Parameter | Type | Required | Description |
451
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
452
- | `request` | [operations.GetIssuedCardTransactionRequest](../../models/operations/getissuedcardtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
453
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
454
- | `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. |
455
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
456
-
457
- ### Response
458
-
459
- **Promise\<[operations.GetIssuedCardTransactionResponse](../../models/operations/getissuedcardtransactionresponse.md)\>**
460
-
461
- ### Errors
462
-
463
- | Error Type | Status Code | Content Type |
464
- | --------------- | --------------- | --------------- |
465
- | errors.APIError | 4XX, 5XX | \*/\* |