@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.
- package/bin/mcp-server.js +79 -61
- package/bin/mcp-server.js.map +11 -10
- package/examples/package-lock.json +1 -1
- package/hooks/hooks.d.ts +3 -2
- package/hooks/hooks.d.ts.map +1 -1
- package/hooks/hooks.js.map +1 -1
- package/hooks/moov-version-hook.d.ts +6 -0
- package/hooks/moov-version-hook.d.ts.map +1 -0
- package/hooks/moov-version-hook.js +12 -0
- package/hooks/moov-version-hook.js.map +1 -0
- package/hooks/registration.d.ts.map +1 -1
- package/hooks/registration.js +3 -1
- package/hooks/registration.js.map +1 -1
- package/hooks/types.d.ts +2 -6
- package/hooks/types.d.ts.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/lib/sdks.d.ts.map +1 -1
- package/lib/sdks.js +5 -6
- package/lib/sdks.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.js +1 -1
- package/package.json +1 -1
- package/src/hooks/hooks.ts +2 -2
- package/src/hooks/moov-version-hook.ts +9 -0
- package/src/hooks/registration.ts +4 -1
- package/src/hooks/types.ts +2 -7
- package/src/lib/config.ts +2 -2
- package/src/lib/sdks.ts +6 -7
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/docs/sdks/accounts/README.md +0 -1038
- package/docs/sdks/accountterminalapplications/README.md +0 -371
- package/docs/sdks/adjustments/README.md +0 -185
- package/docs/sdks/applepay/README.md +0 -572
- package/docs/sdks/authentication/README.md +0 -191
- package/docs/sdks/avatars/README.md +0 -95
- package/docs/sdks/bankaccounts/README.md +0 -951
- package/docs/sdks/branding/README.md +0 -407
- package/docs/sdks/capabilities/README.md +0 -380
- package/docs/sdks/cardissuing/README.md +0 -533
- package/docs/sdks/cards/README.md +0 -544
- package/docs/sdks/disputes/README.md +0 -1085
- package/docs/sdks/endtoendencryption/README.md +0 -174
- package/docs/sdks/enrichedaddress/README.md +0 -95
- package/docs/sdks/enrichedprofile/README.md +0 -95
- package/docs/sdks/feeplans/README.md +0 -921
- package/docs/sdks/files/README.md +0 -293
- package/docs/sdks/images/README.md +0 -616
- package/docs/sdks/industries/README.md +0 -91
- package/docs/sdks/institutions/README.md +0 -184
- package/docs/sdks/issuingtransactions/README.md +0 -465
- package/docs/sdks/onboarding/README.md +0 -389
- package/docs/sdks/paymentlinks/README.md +0 -615
- package/docs/sdks/paymentmethods/README.md +0 -187
- package/docs/sdks/ping/README.md +0 -91
- package/docs/sdks/products/README.md +0 -616
- package/docs/sdks/receipts/README.md +0 -180
- package/docs/sdks/representatives/README.md +0 -603
- package/docs/sdks/scheduling/README.md +0 -1018
- package/docs/sdks/statements/README.md +0 -194
- package/docs/sdks/support/README.md +0 -505
- package/docs/sdks/sweeps/README.md +0 -571
- package/docs/sdks/terminalapplications/README.md +0 -460
- package/docs/sdks/transfers/README.md +0 -1136
- package/docs/sdks/underwriting/README.md +0 -331
- package/docs/sdks/wallets/README.md +0 -416
- package/docs/sdks/wallettransactions/README.md +0 -202
- package/examples/README.md +0 -31
- package/test/README.md +0 -14
|
@@ -1,1085 +0,0 @@
|
|
|
1
|
-
# Disputes
|
|
2
|
-
(*disputes*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [list](#list) - Returns the list of disputes.
|
|
9
|
-
|
|
10
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
11
|
-
|
|
12
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
13
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
14
|
-
* [get](#get) - Get a dispute by ID.
|
|
15
|
-
|
|
16
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
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}/transfers.read` scope.
|
|
20
|
-
* [accept](#accept) - Accepts liability for a dispute.
|
|
21
|
-
|
|
22
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
23
|
-
|
|
24
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
25
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
26
|
-
* [listEvidence](#listevidence) - Returns a dispute's public evidence by its ID.
|
|
27
|
-
|
|
28
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
29
|
-
|
|
30
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
31
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
32
|
-
* [uploadEvidenceFile](#uploadevidencefile) - Uploads a file as evidence for a dispute.
|
|
33
|
-
|
|
34
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
35
|
-
|
|
36
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
37
|
-
you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
|
|
38
|
-
* [uploadEvidenceText](#uploadevidencetext) - Uploads text as evidence for a dispute.
|
|
39
|
-
|
|
40
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
41
|
-
|
|
42
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
43
|
-
you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
|
|
44
|
-
* [submitEvidence](#submitevidence) - Submit the evidence associated with a dispute.
|
|
45
|
-
|
|
46
|
-
Evidence items must be uploaded using the appropriate endpoint(s) prior to calling this endpoint to submit it. **Evidence can only
|
|
47
|
-
be submitted once per dispute.**
|
|
48
|
-
|
|
49
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
50
|
-
|
|
51
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
52
|
-
you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
|
|
53
|
-
* [getEvidence](#getevidence) - Get dispute evidence by ID.
|
|
54
|
-
|
|
55
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
56
|
-
|
|
57
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
58
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
59
|
-
* [updateEvidence](#updateevidence) - Updates dispute evidence by ID.
|
|
60
|
-
|
|
61
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
62
|
-
|
|
63
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
64
|
-
you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
|
|
65
|
-
* [deleteEvidence](#deleteevidence) - Deletes dispute evidence by ID.
|
|
66
|
-
|
|
67
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
68
|
-
|
|
69
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
70
|
-
you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
|
|
71
|
-
* [getEvidenceData](#getevidencedata) - Downloads dispute evidence data by ID.
|
|
72
|
-
|
|
73
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
74
|
-
|
|
75
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
76
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
77
|
-
|
|
78
|
-
## list
|
|
79
|
-
|
|
80
|
-
Returns the list of disputes.
|
|
81
|
-
|
|
82
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
83
|
-
|
|
84
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
85
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
86
|
-
|
|
87
|
-
### Example Usage
|
|
88
|
-
|
|
89
|
-
<!-- UsageSnippet language="typescript" operationID="listDisputes" method="get" path="/accounts/{accountID}/disputes" -->
|
|
90
|
-
```typescript
|
|
91
|
-
import { Moov } from "@moovio/sdk";
|
|
92
|
-
|
|
93
|
-
const moov = new Moov({
|
|
94
|
-
xMoovVersion: "v2024.01.00",
|
|
95
|
-
security: {
|
|
96
|
-
username: "",
|
|
97
|
-
password: "",
|
|
98
|
-
},
|
|
99
|
-
});
|
|
100
|
-
|
|
101
|
-
async function run() {
|
|
102
|
-
const result = await moov.disputes.list({
|
|
103
|
-
accountID: "6fee8f6c-b2c5-44a4-aebb-718335fe4f8e",
|
|
104
|
-
skip: 60,
|
|
105
|
-
count: 20,
|
|
106
|
-
});
|
|
107
|
-
|
|
108
|
-
console.log(result);
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
run();
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### Standalone function
|
|
115
|
-
|
|
116
|
-
The standalone function version of this method:
|
|
117
|
-
|
|
118
|
-
```typescript
|
|
119
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
120
|
-
import { disputesList } from "@moovio/sdk/funcs/disputesList.js";
|
|
121
|
-
|
|
122
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
123
|
-
// You can create one instance of it to use across an application.
|
|
124
|
-
const moov = new MoovCore({
|
|
125
|
-
xMoovVersion: "v2024.01.00",
|
|
126
|
-
security: {
|
|
127
|
-
username: "",
|
|
128
|
-
password: "",
|
|
129
|
-
},
|
|
130
|
-
});
|
|
131
|
-
|
|
132
|
-
async function run() {
|
|
133
|
-
const res = await disputesList(moov, {
|
|
134
|
-
accountID: "6fee8f6c-b2c5-44a4-aebb-718335fe4f8e",
|
|
135
|
-
skip: 60,
|
|
136
|
-
count: 20,
|
|
137
|
-
});
|
|
138
|
-
if (res.ok) {
|
|
139
|
-
const { value: result } = res;
|
|
140
|
-
console.log(result);
|
|
141
|
-
} else {
|
|
142
|
-
console.log("disputesList failed:", res.error);
|
|
143
|
-
}
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
run();
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
### Parameters
|
|
150
|
-
|
|
151
|
-
| Parameter | Type | Required | Description |
|
|
152
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
153
|
-
| `request` | [operations.ListDisputesRequest](../../models/operations/listdisputesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
154
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
155
|
-
| `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. |
|
|
156
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
157
|
-
|
|
158
|
-
### Response
|
|
159
|
-
|
|
160
|
-
**Promise\<[operations.ListDisputesResponse](../../models/operations/listdisputesresponse.md)\>**
|
|
161
|
-
|
|
162
|
-
### Errors
|
|
163
|
-
|
|
164
|
-
| Error Type | Status Code | Content Type |
|
|
165
|
-
| ------------------- | ------------------- | ------------------- |
|
|
166
|
-
| errors.GenericError | 400, 409 | application/json |
|
|
167
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
168
|
-
|
|
169
|
-
## get
|
|
170
|
-
|
|
171
|
-
Get a dispute by ID.
|
|
172
|
-
|
|
173
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
174
|
-
|
|
175
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
176
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
177
|
-
|
|
178
|
-
### Example Usage
|
|
179
|
-
|
|
180
|
-
<!-- UsageSnippet language="typescript" operationID="getDispute" method="get" path="/accounts/{accountID}/disputes/{disputeID}" -->
|
|
181
|
-
```typescript
|
|
182
|
-
import { Moov } from "@moovio/sdk";
|
|
183
|
-
|
|
184
|
-
const moov = new Moov({
|
|
185
|
-
xMoovVersion: "v2024.01.00",
|
|
186
|
-
security: {
|
|
187
|
-
username: "",
|
|
188
|
-
password: "",
|
|
189
|
-
},
|
|
190
|
-
});
|
|
191
|
-
|
|
192
|
-
async function run() {
|
|
193
|
-
const result = await moov.disputes.get({
|
|
194
|
-
accountID: "44d3e9dd-7128-4b00-8cd9-09d3242e5bcf",
|
|
195
|
-
disputeID: "4be10af9-ddeb-428b-8333-7430afce142f",
|
|
196
|
-
});
|
|
197
|
-
|
|
198
|
-
console.log(result);
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
run();
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
### Standalone function
|
|
205
|
-
|
|
206
|
-
The standalone function version of this method:
|
|
207
|
-
|
|
208
|
-
```typescript
|
|
209
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
210
|
-
import { disputesGet } from "@moovio/sdk/funcs/disputesGet.js";
|
|
211
|
-
|
|
212
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
213
|
-
// You can create one instance of it to use across an application.
|
|
214
|
-
const moov = new MoovCore({
|
|
215
|
-
xMoovVersion: "v2024.01.00",
|
|
216
|
-
security: {
|
|
217
|
-
username: "",
|
|
218
|
-
password: "",
|
|
219
|
-
},
|
|
220
|
-
});
|
|
221
|
-
|
|
222
|
-
async function run() {
|
|
223
|
-
const res = await disputesGet(moov, {
|
|
224
|
-
accountID: "44d3e9dd-7128-4b00-8cd9-09d3242e5bcf",
|
|
225
|
-
disputeID: "4be10af9-ddeb-428b-8333-7430afce142f",
|
|
226
|
-
});
|
|
227
|
-
if (res.ok) {
|
|
228
|
-
const { value: result } = res;
|
|
229
|
-
console.log(result);
|
|
230
|
-
} else {
|
|
231
|
-
console.log("disputesGet failed:", res.error);
|
|
232
|
-
}
|
|
233
|
-
}
|
|
234
|
-
|
|
235
|
-
run();
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
### Parameters
|
|
239
|
-
|
|
240
|
-
| Parameter | Type | Required | Description |
|
|
241
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
242
|
-
| `request` | [operations.GetDisputeRequest](../../models/operations/getdisputerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
243
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
244
|
-
| `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. |
|
|
245
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
246
|
-
|
|
247
|
-
### Response
|
|
248
|
-
|
|
249
|
-
**Promise\<[operations.GetDisputeResponse](../../models/operations/getdisputeresponse.md)\>**
|
|
250
|
-
|
|
251
|
-
### Errors
|
|
252
|
-
|
|
253
|
-
| Error Type | Status Code | Content Type |
|
|
254
|
-
| --------------- | --------------- | --------------- |
|
|
255
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
256
|
-
|
|
257
|
-
## accept
|
|
258
|
-
|
|
259
|
-
Accepts liability for a dispute.
|
|
260
|
-
|
|
261
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
262
|
-
|
|
263
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
264
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
265
|
-
|
|
266
|
-
### Example Usage
|
|
267
|
-
|
|
268
|
-
<!-- UsageSnippet language="typescript" operationID="acceptDispute" method="post" path="/accounts/{accountID}/disputes/{disputeID}/accept" -->
|
|
269
|
-
```typescript
|
|
270
|
-
import { Moov } from "@moovio/sdk";
|
|
271
|
-
|
|
272
|
-
const moov = new Moov({
|
|
273
|
-
xMoovVersion: "v2024.01.00",
|
|
274
|
-
security: {
|
|
275
|
-
username: "",
|
|
276
|
-
password: "",
|
|
277
|
-
},
|
|
278
|
-
});
|
|
279
|
-
|
|
280
|
-
async function run() {
|
|
281
|
-
const result = await moov.disputes.accept({
|
|
282
|
-
accountID: "ef028cdd-49e0-4cd8-9c89-6673e28e226e",
|
|
283
|
-
disputeID: "b7cf0931-5fbb-4e79-94cb-96291b634f63",
|
|
284
|
-
});
|
|
285
|
-
|
|
286
|
-
console.log(result);
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
run();
|
|
290
|
-
```
|
|
291
|
-
|
|
292
|
-
### Standalone function
|
|
293
|
-
|
|
294
|
-
The standalone function version of this method:
|
|
295
|
-
|
|
296
|
-
```typescript
|
|
297
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
298
|
-
import { disputesAccept } from "@moovio/sdk/funcs/disputesAccept.js";
|
|
299
|
-
|
|
300
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
301
|
-
// You can create one instance of it to use across an application.
|
|
302
|
-
const moov = new MoovCore({
|
|
303
|
-
xMoovVersion: "v2024.01.00",
|
|
304
|
-
security: {
|
|
305
|
-
username: "",
|
|
306
|
-
password: "",
|
|
307
|
-
},
|
|
308
|
-
});
|
|
309
|
-
|
|
310
|
-
async function run() {
|
|
311
|
-
const res = await disputesAccept(moov, {
|
|
312
|
-
accountID: "ef028cdd-49e0-4cd8-9c89-6673e28e226e",
|
|
313
|
-
disputeID: "b7cf0931-5fbb-4e79-94cb-96291b634f63",
|
|
314
|
-
});
|
|
315
|
-
if (res.ok) {
|
|
316
|
-
const { value: result } = res;
|
|
317
|
-
console.log(result);
|
|
318
|
-
} else {
|
|
319
|
-
console.log("disputesAccept failed:", res.error);
|
|
320
|
-
}
|
|
321
|
-
}
|
|
322
|
-
|
|
323
|
-
run();
|
|
324
|
-
```
|
|
325
|
-
|
|
326
|
-
### Parameters
|
|
327
|
-
|
|
328
|
-
| Parameter | Type | Required | Description |
|
|
329
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
330
|
-
| `request` | [operations.AcceptDisputeRequest](../../models/operations/acceptdisputerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
331
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
332
|
-
| `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. |
|
|
333
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
334
|
-
|
|
335
|
-
### Response
|
|
336
|
-
|
|
337
|
-
**Promise\<[operations.AcceptDisputeResponse](../../models/operations/acceptdisputeresponse.md)\>**
|
|
338
|
-
|
|
339
|
-
### Errors
|
|
340
|
-
|
|
341
|
-
| Error Type | Status Code | Content Type |
|
|
342
|
-
| ------------------- | ------------------- | ------------------- |
|
|
343
|
-
| errors.GenericError | 400, 409 | application/json |
|
|
344
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
345
|
-
|
|
346
|
-
## listEvidence
|
|
347
|
-
|
|
348
|
-
Returns a dispute's public evidence by its ID.
|
|
349
|
-
|
|
350
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
351
|
-
|
|
352
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
353
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
354
|
-
|
|
355
|
-
### Example Usage
|
|
356
|
-
|
|
357
|
-
<!-- UsageSnippet language="typescript" operationID="listDisputeEvidence" method="get" path="/accounts/{accountID}/disputes/{disputeID}/evidence" -->
|
|
358
|
-
```typescript
|
|
359
|
-
import { Moov } from "@moovio/sdk";
|
|
360
|
-
|
|
361
|
-
const moov = new Moov({
|
|
362
|
-
xMoovVersion: "v2024.01.00",
|
|
363
|
-
security: {
|
|
364
|
-
username: "",
|
|
365
|
-
password: "",
|
|
366
|
-
},
|
|
367
|
-
});
|
|
368
|
-
|
|
369
|
-
async function run() {
|
|
370
|
-
const result = await moov.disputes.listEvidence({
|
|
371
|
-
accountID: "efc12040-97af-4720-91c5-14cd1a83877b",
|
|
372
|
-
disputeID: "f1c23432-4110-4981-9b72-b98df94bb61c",
|
|
373
|
-
});
|
|
374
|
-
|
|
375
|
-
console.log(result);
|
|
376
|
-
}
|
|
377
|
-
|
|
378
|
-
run();
|
|
379
|
-
```
|
|
380
|
-
|
|
381
|
-
### Standalone function
|
|
382
|
-
|
|
383
|
-
The standalone function version of this method:
|
|
384
|
-
|
|
385
|
-
```typescript
|
|
386
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
387
|
-
import { disputesListEvidence } from "@moovio/sdk/funcs/disputesListEvidence.js";
|
|
388
|
-
|
|
389
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
390
|
-
// You can create one instance of it to use across an application.
|
|
391
|
-
const moov = new MoovCore({
|
|
392
|
-
xMoovVersion: "v2024.01.00",
|
|
393
|
-
security: {
|
|
394
|
-
username: "",
|
|
395
|
-
password: "",
|
|
396
|
-
},
|
|
397
|
-
});
|
|
398
|
-
|
|
399
|
-
async function run() {
|
|
400
|
-
const res = await disputesListEvidence(moov, {
|
|
401
|
-
accountID: "efc12040-97af-4720-91c5-14cd1a83877b",
|
|
402
|
-
disputeID: "f1c23432-4110-4981-9b72-b98df94bb61c",
|
|
403
|
-
});
|
|
404
|
-
if (res.ok) {
|
|
405
|
-
const { value: result } = res;
|
|
406
|
-
console.log(result);
|
|
407
|
-
} else {
|
|
408
|
-
console.log("disputesListEvidence failed:", res.error);
|
|
409
|
-
}
|
|
410
|
-
}
|
|
411
|
-
|
|
412
|
-
run();
|
|
413
|
-
```
|
|
414
|
-
|
|
415
|
-
### Parameters
|
|
416
|
-
|
|
417
|
-
| Parameter | Type | Required | Description |
|
|
418
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
419
|
-
| `request` | [operations.ListDisputeEvidenceRequest](../../models/operations/listdisputeevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
420
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
421
|
-
| `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. |
|
|
422
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
423
|
-
|
|
424
|
-
### Response
|
|
425
|
-
|
|
426
|
-
**Promise\<[operations.ListDisputeEvidenceResponse](../../models/operations/listdisputeevidenceresponse.md)\>**
|
|
427
|
-
|
|
428
|
-
### Errors
|
|
429
|
-
|
|
430
|
-
| Error Type | Status Code | Content Type |
|
|
431
|
-
| --------------- | --------------- | --------------- |
|
|
432
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
433
|
-
|
|
434
|
-
## uploadEvidenceFile
|
|
435
|
-
|
|
436
|
-
Uploads a file as evidence for a dispute.
|
|
437
|
-
|
|
438
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
439
|
-
|
|
440
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
441
|
-
you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
|
|
442
|
-
|
|
443
|
-
### Example Usage
|
|
444
|
-
|
|
445
|
-
<!-- UsageSnippet language="typescript" operationID="uploadDisputeEvidenceFile" method="post" path="/accounts/{accountID}/disputes/{disputeID}/evidence-file" -->
|
|
446
|
-
```typescript
|
|
447
|
-
import { Moov } from "@moovio/sdk";
|
|
448
|
-
import { openAsBlob } from "node:fs";
|
|
449
|
-
|
|
450
|
-
const moov = new Moov({
|
|
451
|
-
xMoovVersion: "v2024.01.00",
|
|
452
|
-
security: {
|
|
453
|
-
username: "",
|
|
454
|
-
password: "",
|
|
455
|
-
},
|
|
456
|
-
});
|
|
457
|
-
|
|
458
|
-
async function run() {
|
|
459
|
-
const result = await moov.disputes.uploadEvidenceFile({
|
|
460
|
-
accountID: "c09fd2f8-75fb-4ed9-be03-f8565d3ddc67",
|
|
461
|
-
disputeID: "ad27f84d-00b1-4db0-8cf5-be001d71251d",
|
|
462
|
-
createEvidenceFileMultiPart: {
|
|
463
|
-
file: await openAsBlob("example.file"),
|
|
464
|
-
evidenceType: "cancelation-policy",
|
|
465
|
-
},
|
|
466
|
-
});
|
|
467
|
-
|
|
468
|
-
console.log(result);
|
|
469
|
-
}
|
|
470
|
-
|
|
471
|
-
run();
|
|
472
|
-
```
|
|
473
|
-
|
|
474
|
-
### Standalone function
|
|
475
|
-
|
|
476
|
-
The standalone function version of this method:
|
|
477
|
-
|
|
478
|
-
```typescript
|
|
479
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
480
|
-
import { disputesUploadEvidenceFile } from "@moovio/sdk/funcs/disputesUploadEvidenceFile.js";
|
|
481
|
-
import { openAsBlob } from "node:fs";
|
|
482
|
-
|
|
483
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
484
|
-
// You can create one instance of it to use across an application.
|
|
485
|
-
const moov = new MoovCore({
|
|
486
|
-
xMoovVersion: "v2024.01.00",
|
|
487
|
-
security: {
|
|
488
|
-
username: "",
|
|
489
|
-
password: "",
|
|
490
|
-
},
|
|
491
|
-
});
|
|
492
|
-
|
|
493
|
-
async function run() {
|
|
494
|
-
const res = await disputesUploadEvidenceFile(moov, {
|
|
495
|
-
accountID: "c09fd2f8-75fb-4ed9-be03-f8565d3ddc67",
|
|
496
|
-
disputeID: "ad27f84d-00b1-4db0-8cf5-be001d71251d",
|
|
497
|
-
createEvidenceFileMultiPart: {
|
|
498
|
-
file: await openAsBlob("example.file"),
|
|
499
|
-
evidenceType: "cancelation-policy",
|
|
500
|
-
},
|
|
501
|
-
});
|
|
502
|
-
if (res.ok) {
|
|
503
|
-
const { value: result } = res;
|
|
504
|
-
console.log(result);
|
|
505
|
-
} else {
|
|
506
|
-
console.log("disputesUploadEvidenceFile failed:", res.error);
|
|
507
|
-
}
|
|
508
|
-
}
|
|
509
|
-
|
|
510
|
-
run();
|
|
511
|
-
```
|
|
512
|
-
|
|
513
|
-
### Parameters
|
|
514
|
-
|
|
515
|
-
| Parameter | Type | Required | Description |
|
|
516
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
517
|
-
| `request` | [operations.UploadDisputeEvidenceFileRequest](../../models/operations/uploaddisputeevidencefilerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
518
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
519
|
-
| `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. |
|
|
520
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
521
|
-
|
|
522
|
-
### Response
|
|
523
|
-
|
|
524
|
-
**Promise\<[operations.UploadDisputeEvidenceFileResponse](../../models/operations/uploaddisputeevidencefileresponse.md)\>**
|
|
525
|
-
|
|
526
|
-
### Errors
|
|
527
|
-
|
|
528
|
-
| Error Type | Status Code | Content Type |
|
|
529
|
-
| -------------------------------- | -------------------------------- | -------------------------------- |
|
|
530
|
-
| errors.GenericError | 400, 409 | application/json |
|
|
531
|
-
| errors.FileUploadValidationError | 422 | application/json |
|
|
532
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
533
|
-
|
|
534
|
-
## uploadEvidenceText
|
|
535
|
-
|
|
536
|
-
Uploads text as evidence for a dispute.
|
|
537
|
-
|
|
538
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
539
|
-
|
|
540
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
541
|
-
you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
|
|
542
|
-
|
|
543
|
-
### Example Usage
|
|
544
|
-
|
|
545
|
-
<!-- UsageSnippet language="typescript" operationID="uploadDisputeEvidenceText" method="post" path="/accounts/{accountID}/disputes/{disputeID}/evidence-text" -->
|
|
546
|
-
```typescript
|
|
547
|
-
import { Moov } from "@moovio/sdk";
|
|
548
|
-
|
|
549
|
-
const moov = new Moov({
|
|
550
|
-
xMoovVersion: "v2024.01.00",
|
|
551
|
-
security: {
|
|
552
|
-
username: "",
|
|
553
|
-
password: "",
|
|
554
|
-
},
|
|
555
|
-
});
|
|
556
|
-
|
|
557
|
-
async function run() {
|
|
558
|
-
const result = await moov.disputes.uploadEvidenceText({
|
|
559
|
-
accountID: "ed2ca924-e2c4-4f3a-b077-866bb07b0671",
|
|
560
|
-
disputeID: "14832e8d-3613-45ce-942e-3116b9e0d194",
|
|
561
|
-
createEvidenceText: {
|
|
562
|
-
text: "<value>",
|
|
563
|
-
evidenceType: "generic-evidence",
|
|
564
|
-
},
|
|
565
|
-
});
|
|
566
|
-
|
|
567
|
-
console.log(result);
|
|
568
|
-
}
|
|
569
|
-
|
|
570
|
-
run();
|
|
571
|
-
```
|
|
572
|
-
|
|
573
|
-
### Standalone function
|
|
574
|
-
|
|
575
|
-
The standalone function version of this method:
|
|
576
|
-
|
|
577
|
-
```typescript
|
|
578
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
579
|
-
import { disputesUploadEvidenceText } from "@moovio/sdk/funcs/disputesUploadEvidenceText.js";
|
|
580
|
-
|
|
581
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
582
|
-
// You can create one instance of it to use across an application.
|
|
583
|
-
const moov = new MoovCore({
|
|
584
|
-
xMoovVersion: "v2024.01.00",
|
|
585
|
-
security: {
|
|
586
|
-
username: "",
|
|
587
|
-
password: "",
|
|
588
|
-
},
|
|
589
|
-
});
|
|
590
|
-
|
|
591
|
-
async function run() {
|
|
592
|
-
const res = await disputesUploadEvidenceText(moov, {
|
|
593
|
-
accountID: "ed2ca924-e2c4-4f3a-b077-866bb07b0671",
|
|
594
|
-
disputeID: "14832e8d-3613-45ce-942e-3116b9e0d194",
|
|
595
|
-
createEvidenceText: {
|
|
596
|
-
text: "<value>",
|
|
597
|
-
evidenceType: "generic-evidence",
|
|
598
|
-
},
|
|
599
|
-
});
|
|
600
|
-
if (res.ok) {
|
|
601
|
-
const { value: result } = res;
|
|
602
|
-
console.log(result);
|
|
603
|
-
} else {
|
|
604
|
-
console.log("disputesUploadEvidenceText failed:", res.error);
|
|
605
|
-
}
|
|
606
|
-
}
|
|
607
|
-
|
|
608
|
-
run();
|
|
609
|
-
```
|
|
610
|
-
|
|
611
|
-
### Parameters
|
|
612
|
-
|
|
613
|
-
| Parameter | Type | Required | Description |
|
|
614
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
615
|
-
| `request` | [operations.UploadDisputeEvidenceTextRequest](../../models/operations/uploaddisputeevidencetextrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
616
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
617
|
-
| `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. |
|
|
618
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
619
|
-
|
|
620
|
-
### Response
|
|
621
|
-
|
|
622
|
-
**Promise\<[operations.UploadDisputeEvidenceTextResponse](../../models/operations/uploaddisputeevidencetextresponse.md)\>**
|
|
623
|
-
|
|
624
|
-
### Errors
|
|
625
|
-
|
|
626
|
-
| Error Type | Status Code | Content Type |
|
|
627
|
-
| ------------------- | ------------------- | ------------------- |
|
|
628
|
-
| errors.GenericError | 400, 409 | application/json |
|
|
629
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
630
|
-
|
|
631
|
-
## submitEvidence
|
|
632
|
-
|
|
633
|
-
Submit the evidence associated with a dispute.
|
|
634
|
-
|
|
635
|
-
Evidence items must be uploaded using the appropriate endpoint(s) prior to calling this endpoint to submit it. **Evidence can only
|
|
636
|
-
be submitted once per dispute.**
|
|
637
|
-
|
|
638
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
639
|
-
|
|
640
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
641
|
-
you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
|
|
642
|
-
|
|
643
|
-
### Example Usage
|
|
644
|
-
|
|
645
|
-
<!-- UsageSnippet language="typescript" operationID="submitDisputeEvidence" method="post" path="/accounts/{accountID}/disputes/{disputeID}/evidence/submit" -->
|
|
646
|
-
```typescript
|
|
647
|
-
import { Moov } from "@moovio/sdk";
|
|
648
|
-
|
|
649
|
-
const moov = new Moov({
|
|
650
|
-
xMoovVersion: "v2024.01.00",
|
|
651
|
-
security: {
|
|
652
|
-
username: "",
|
|
653
|
-
password: "",
|
|
654
|
-
},
|
|
655
|
-
});
|
|
656
|
-
|
|
657
|
-
async function run() {
|
|
658
|
-
const result = await moov.disputes.submitEvidence({
|
|
659
|
-
accountID: "01f79d04-f2de-42de-9e37-23c751edecb4",
|
|
660
|
-
disputeID: "8c5d6d6e-420a-49c8-b7c3-d4b5d1bbd415",
|
|
661
|
-
});
|
|
662
|
-
|
|
663
|
-
console.log(result);
|
|
664
|
-
}
|
|
665
|
-
|
|
666
|
-
run();
|
|
667
|
-
```
|
|
668
|
-
|
|
669
|
-
### Standalone function
|
|
670
|
-
|
|
671
|
-
The standalone function version of this method:
|
|
672
|
-
|
|
673
|
-
```typescript
|
|
674
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
675
|
-
import { disputesSubmitEvidence } from "@moovio/sdk/funcs/disputesSubmitEvidence.js";
|
|
676
|
-
|
|
677
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
678
|
-
// You can create one instance of it to use across an application.
|
|
679
|
-
const moov = new MoovCore({
|
|
680
|
-
xMoovVersion: "v2024.01.00",
|
|
681
|
-
security: {
|
|
682
|
-
username: "",
|
|
683
|
-
password: "",
|
|
684
|
-
},
|
|
685
|
-
});
|
|
686
|
-
|
|
687
|
-
async function run() {
|
|
688
|
-
const res = await disputesSubmitEvidence(moov, {
|
|
689
|
-
accountID: "01f79d04-f2de-42de-9e37-23c751edecb4",
|
|
690
|
-
disputeID: "8c5d6d6e-420a-49c8-b7c3-d4b5d1bbd415",
|
|
691
|
-
});
|
|
692
|
-
if (res.ok) {
|
|
693
|
-
const { value: result } = res;
|
|
694
|
-
console.log(result);
|
|
695
|
-
} else {
|
|
696
|
-
console.log("disputesSubmitEvidence failed:", res.error);
|
|
697
|
-
}
|
|
698
|
-
}
|
|
699
|
-
|
|
700
|
-
run();
|
|
701
|
-
```
|
|
702
|
-
|
|
703
|
-
### Parameters
|
|
704
|
-
|
|
705
|
-
| Parameter | Type | Required | Description |
|
|
706
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
707
|
-
| `request` | [operations.SubmitDisputeEvidenceRequest](../../models/operations/submitdisputeevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
708
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
709
|
-
| `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. |
|
|
710
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
711
|
-
|
|
712
|
-
### Response
|
|
713
|
-
|
|
714
|
-
**Promise\<[operations.SubmitDisputeEvidenceResponse](../../models/operations/submitdisputeevidenceresponse.md)\>**
|
|
715
|
-
|
|
716
|
-
### Errors
|
|
717
|
-
|
|
718
|
-
| Error Type | Status Code | Content Type |
|
|
719
|
-
| ------------------- | ------------------- | ------------------- |
|
|
720
|
-
| errors.GenericError | 400, 409 | application/json |
|
|
721
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
722
|
-
|
|
723
|
-
## getEvidence
|
|
724
|
-
|
|
725
|
-
Get dispute evidence by ID.
|
|
726
|
-
|
|
727
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
728
|
-
|
|
729
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
730
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
731
|
-
|
|
732
|
-
### Example Usage
|
|
733
|
-
|
|
734
|
-
<!-- UsageSnippet language="typescript" operationID="getDisputeEvidence" method="get" path="/accounts/{accountID}/disputes/{disputeID}/evidence/{evidenceID}" -->
|
|
735
|
-
```typescript
|
|
736
|
-
import { Moov } from "@moovio/sdk";
|
|
737
|
-
|
|
738
|
-
const moov = new Moov({
|
|
739
|
-
xMoovVersion: "v2024.01.00",
|
|
740
|
-
security: {
|
|
741
|
-
username: "",
|
|
742
|
-
password: "",
|
|
743
|
-
},
|
|
744
|
-
});
|
|
745
|
-
|
|
746
|
-
async function run() {
|
|
747
|
-
const result = await moov.disputes.getEvidence({
|
|
748
|
-
accountID: "ab59cc9a-6480-40fe-8a06-8c41883e3c79",
|
|
749
|
-
disputeID: "4fc54609-7e6b-4a75-b8b3-7ffbeb138e22",
|
|
750
|
-
evidenceID: "08c4d04c-1296-4bfd-bafb-bee195f85785",
|
|
751
|
-
});
|
|
752
|
-
|
|
753
|
-
console.log(result);
|
|
754
|
-
}
|
|
755
|
-
|
|
756
|
-
run();
|
|
757
|
-
```
|
|
758
|
-
|
|
759
|
-
### Standalone function
|
|
760
|
-
|
|
761
|
-
The standalone function version of this method:
|
|
762
|
-
|
|
763
|
-
```typescript
|
|
764
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
765
|
-
import { disputesGetEvidence } from "@moovio/sdk/funcs/disputesGetEvidence.js";
|
|
766
|
-
|
|
767
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
768
|
-
// You can create one instance of it to use across an application.
|
|
769
|
-
const moov = new MoovCore({
|
|
770
|
-
xMoovVersion: "v2024.01.00",
|
|
771
|
-
security: {
|
|
772
|
-
username: "",
|
|
773
|
-
password: "",
|
|
774
|
-
},
|
|
775
|
-
});
|
|
776
|
-
|
|
777
|
-
async function run() {
|
|
778
|
-
const res = await disputesGetEvidence(moov, {
|
|
779
|
-
accountID: "ab59cc9a-6480-40fe-8a06-8c41883e3c79",
|
|
780
|
-
disputeID: "4fc54609-7e6b-4a75-b8b3-7ffbeb138e22",
|
|
781
|
-
evidenceID: "08c4d04c-1296-4bfd-bafb-bee195f85785",
|
|
782
|
-
});
|
|
783
|
-
if (res.ok) {
|
|
784
|
-
const { value: result } = res;
|
|
785
|
-
console.log(result);
|
|
786
|
-
} else {
|
|
787
|
-
console.log("disputesGetEvidence failed:", res.error);
|
|
788
|
-
}
|
|
789
|
-
}
|
|
790
|
-
|
|
791
|
-
run();
|
|
792
|
-
```
|
|
793
|
-
|
|
794
|
-
### Parameters
|
|
795
|
-
|
|
796
|
-
| Parameter | Type | Required | Description |
|
|
797
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
798
|
-
| `request` | [operations.GetDisputeEvidenceRequest](../../models/operations/getdisputeevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
799
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
800
|
-
| `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. |
|
|
801
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
802
|
-
|
|
803
|
-
### Response
|
|
804
|
-
|
|
805
|
-
**Promise\<[operations.GetDisputeEvidenceResponse](../../models/operations/getdisputeevidenceresponse.md)\>**
|
|
806
|
-
|
|
807
|
-
### Errors
|
|
808
|
-
|
|
809
|
-
| Error Type | Status Code | Content Type |
|
|
810
|
-
| --------------- | --------------- | --------------- |
|
|
811
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
812
|
-
|
|
813
|
-
## updateEvidence
|
|
814
|
-
|
|
815
|
-
Updates dispute evidence by ID.
|
|
816
|
-
|
|
817
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
818
|
-
|
|
819
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
820
|
-
you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
|
|
821
|
-
|
|
822
|
-
### Example Usage
|
|
823
|
-
|
|
824
|
-
<!-- UsageSnippet language="typescript" operationID="updateDisputeEvidence" method="patch" path="/accounts/{accountID}/disputes/{disputeID}/evidence/{evidenceID}" -->
|
|
825
|
-
```typescript
|
|
826
|
-
import { Moov } from "@moovio/sdk";
|
|
827
|
-
|
|
828
|
-
const moov = new Moov({
|
|
829
|
-
xMoovVersion: "v2024.01.00",
|
|
830
|
-
security: {
|
|
831
|
-
username: "",
|
|
832
|
-
password: "",
|
|
833
|
-
},
|
|
834
|
-
});
|
|
835
|
-
|
|
836
|
-
async function run() {
|
|
837
|
-
const result = await moov.disputes.updateEvidence({
|
|
838
|
-
accountID: "bc2af75d-427a-486d-8580-3adfa9599023",
|
|
839
|
-
disputeID: "36df0cea-d95d-427e-ba60-c9923d1e25a7",
|
|
840
|
-
evidenceID: "fd46ede8-5d47-4e5e-91a7-9af8162f76b2",
|
|
841
|
-
updateEvidence: {},
|
|
842
|
-
});
|
|
843
|
-
|
|
844
|
-
console.log(result);
|
|
845
|
-
}
|
|
846
|
-
|
|
847
|
-
run();
|
|
848
|
-
```
|
|
849
|
-
|
|
850
|
-
### Standalone function
|
|
851
|
-
|
|
852
|
-
The standalone function version of this method:
|
|
853
|
-
|
|
854
|
-
```typescript
|
|
855
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
856
|
-
import { disputesUpdateEvidence } from "@moovio/sdk/funcs/disputesUpdateEvidence.js";
|
|
857
|
-
|
|
858
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
859
|
-
// You can create one instance of it to use across an application.
|
|
860
|
-
const moov = new MoovCore({
|
|
861
|
-
xMoovVersion: "v2024.01.00",
|
|
862
|
-
security: {
|
|
863
|
-
username: "",
|
|
864
|
-
password: "",
|
|
865
|
-
},
|
|
866
|
-
});
|
|
867
|
-
|
|
868
|
-
async function run() {
|
|
869
|
-
const res = await disputesUpdateEvidence(moov, {
|
|
870
|
-
accountID: "bc2af75d-427a-486d-8580-3adfa9599023",
|
|
871
|
-
disputeID: "36df0cea-d95d-427e-ba60-c9923d1e25a7",
|
|
872
|
-
evidenceID: "fd46ede8-5d47-4e5e-91a7-9af8162f76b2",
|
|
873
|
-
updateEvidence: {},
|
|
874
|
-
});
|
|
875
|
-
if (res.ok) {
|
|
876
|
-
const { value: result } = res;
|
|
877
|
-
console.log(result);
|
|
878
|
-
} else {
|
|
879
|
-
console.log("disputesUpdateEvidence failed:", res.error);
|
|
880
|
-
}
|
|
881
|
-
}
|
|
882
|
-
|
|
883
|
-
run();
|
|
884
|
-
```
|
|
885
|
-
|
|
886
|
-
### Parameters
|
|
887
|
-
|
|
888
|
-
| Parameter | Type | Required | Description |
|
|
889
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
890
|
-
| `request` | [operations.UpdateDisputeEvidenceRequest](../../models/operations/updatedisputeevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
891
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
892
|
-
| `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. |
|
|
893
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
894
|
-
|
|
895
|
-
### Response
|
|
896
|
-
|
|
897
|
-
**Promise\<[operations.UpdateDisputeEvidenceResponse](../../models/operations/updatedisputeevidenceresponse.md)\>**
|
|
898
|
-
|
|
899
|
-
### Errors
|
|
900
|
-
|
|
901
|
-
| Error Type | Status Code | Content Type |
|
|
902
|
-
| ------------------- | ------------------- | ------------------- |
|
|
903
|
-
| errors.GenericError | 400 | application/json |
|
|
904
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
905
|
-
|
|
906
|
-
## deleteEvidence
|
|
907
|
-
|
|
908
|
-
Deletes dispute evidence by ID.
|
|
909
|
-
|
|
910
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
911
|
-
|
|
912
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
913
|
-
you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
|
|
914
|
-
|
|
915
|
-
### Example Usage
|
|
916
|
-
|
|
917
|
-
<!-- UsageSnippet language="typescript" operationID="deleteDisputeEvidenceFile" method="delete" path="/accounts/{accountID}/disputes/{disputeID}/evidence/{evidenceID}" -->
|
|
918
|
-
```typescript
|
|
919
|
-
import { Moov } from "@moovio/sdk";
|
|
920
|
-
|
|
921
|
-
const moov = new Moov({
|
|
922
|
-
xMoovVersion: "v2024.01.00",
|
|
923
|
-
security: {
|
|
924
|
-
username: "",
|
|
925
|
-
password: "",
|
|
926
|
-
},
|
|
927
|
-
});
|
|
928
|
-
|
|
929
|
-
async function run() {
|
|
930
|
-
const result = await moov.disputes.deleteEvidence({
|
|
931
|
-
accountID: "b21731c6-3497-46a3-859a-3761a6b8e096",
|
|
932
|
-
disputeID: "1759456d-80e3-4428-a08d-302c8877b418",
|
|
933
|
-
evidenceID: "ea10cba6-166f-464d-b57b-30d995d44b98",
|
|
934
|
-
});
|
|
935
|
-
|
|
936
|
-
console.log(result);
|
|
937
|
-
}
|
|
938
|
-
|
|
939
|
-
run();
|
|
940
|
-
```
|
|
941
|
-
|
|
942
|
-
### Standalone function
|
|
943
|
-
|
|
944
|
-
The standalone function version of this method:
|
|
945
|
-
|
|
946
|
-
```typescript
|
|
947
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
948
|
-
import { disputesDeleteEvidence } from "@moovio/sdk/funcs/disputesDeleteEvidence.js";
|
|
949
|
-
|
|
950
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
951
|
-
// You can create one instance of it to use across an application.
|
|
952
|
-
const moov = new MoovCore({
|
|
953
|
-
xMoovVersion: "v2024.01.00",
|
|
954
|
-
security: {
|
|
955
|
-
username: "",
|
|
956
|
-
password: "",
|
|
957
|
-
},
|
|
958
|
-
});
|
|
959
|
-
|
|
960
|
-
async function run() {
|
|
961
|
-
const res = await disputesDeleteEvidence(moov, {
|
|
962
|
-
accountID: "b21731c6-3497-46a3-859a-3761a6b8e096",
|
|
963
|
-
disputeID: "1759456d-80e3-4428-a08d-302c8877b418",
|
|
964
|
-
evidenceID: "ea10cba6-166f-464d-b57b-30d995d44b98",
|
|
965
|
-
});
|
|
966
|
-
if (res.ok) {
|
|
967
|
-
const { value: result } = res;
|
|
968
|
-
console.log(result);
|
|
969
|
-
} else {
|
|
970
|
-
console.log("disputesDeleteEvidence failed:", res.error);
|
|
971
|
-
}
|
|
972
|
-
}
|
|
973
|
-
|
|
974
|
-
run();
|
|
975
|
-
```
|
|
976
|
-
|
|
977
|
-
### Parameters
|
|
978
|
-
|
|
979
|
-
| Parameter | Type | Required | Description |
|
|
980
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
981
|
-
| `request` | [operations.DeleteDisputeEvidenceFileRequest](../../models/operations/deletedisputeevidencefilerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
982
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
983
|
-
| `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. |
|
|
984
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
985
|
-
|
|
986
|
-
### Response
|
|
987
|
-
|
|
988
|
-
**Promise\<[operations.DeleteDisputeEvidenceFileResponse](../../models/operations/deletedisputeevidencefileresponse.md)\>**
|
|
989
|
-
|
|
990
|
-
### Errors
|
|
991
|
-
|
|
992
|
-
| Error Type | Status Code | Content Type |
|
|
993
|
-
| ------------------- | ------------------- | ------------------- |
|
|
994
|
-
| errors.GenericError | 409 | application/json |
|
|
995
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
996
|
-
|
|
997
|
-
## getEvidenceData
|
|
998
|
-
|
|
999
|
-
Downloads dispute evidence data by ID.
|
|
1000
|
-
|
|
1001
|
-
Read our [disputes guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/disputes/) to learn more.
|
|
1002
|
-
|
|
1003
|
-
To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
|
|
1004
|
-
you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
|
|
1005
|
-
|
|
1006
|
-
### Example Usage
|
|
1007
|
-
|
|
1008
|
-
<!-- UsageSnippet language="typescript" operationID="getDisputeEvidenceData" method="get" path="/accounts/{accountID}/disputes/{disputeID}/evidence/{evidenceID}/data" -->
|
|
1009
|
-
```typescript
|
|
1010
|
-
import { Moov } from "@moovio/sdk";
|
|
1011
|
-
|
|
1012
|
-
const moov = new Moov({
|
|
1013
|
-
xMoovVersion: "v2024.01.00",
|
|
1014
|
-
security: {
|
|
1015
|
-
username: "",
|
|
1016
|
-
password: "",
|
|
1017
|
-
},
|
|
1018
|
-
});
|
|
1019
|
-
|
|
1020
|
-
async function run() {
|
|
1021
|
-
const result = await moov.disputes.getEvidenceData({
|
|
1022
|
-
accountID: "83e6bc61-f894-4cd8-b847-d617383323fb",
|
|
1023
|
-
disputeID: "b7e45862-1e55-4ba0-842f-9fce30c0228b",
|
|
1024
|
-
evidenceID: "3d195b92-798e-4ea4-9347-1c86efacbf38",
|
|
1025
|
-
});
|
|
1026
|
-
|
|
1027
|
-
console.log(result);
|
|
1028
|
-
}
|
|
1029
|
-
|
|
1030
|
-
run();
|
|
1031
|
-
```
|
|
1032
|
-
|
|
1033
|
-
### Standalone function
|
|
1034
|
-
|
|
1035
|
-
The standalone function version of this method:
|
|
1036
|
-
|
|
1037
|
-
```typescript
|
|
1038
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
1039
|
-
import { disputesGetEvidenceData } from "@moovio/sdk/funcs/disputesGetEvidenceData.js";
|
|
1040
|
-
|
|
1041
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
1042
|
-
// You can create one instance of it to use across an application.
|
|
1043
|
-
const moov = new MoovCore({
|
|
1044
|
-
xMoovVersion: "v2024.01.00",
|
|
1045
|
-
security: {
|
|
1046
|
-
username: "",
|
|
1047
|
-
password: "",
|
|
1048
|
-
},
|
|
1049
|
-
});
|
|
1050
|
-
|
|
1051
|
-
async function run() {
|
|
1052
|
-
const res = await disputesGetEvidenceData(moov, {
|
|
1053
|
-
accountID: "83e6bc61-f894-4cd8-b847-d617383323fb",
|
|
1054
|
-
disputeID: "b7e45862-1e55-4ba0-842f-9fce30c0228b",
|
|
1055
|
-
evidenceID: "3d195b92-798e-4ea4-9347-1c86efacbf38",
|
|
1056
|
-
});
|
|
1057
|
-
if (res.ok) {
|
|
1058
|
-
const { value: result } = res;
|
|
1059
|
-
console.log(result);
|
|
1060
|
-
} else {
|
|
1061
|
-
console.log("disputesGetEvidenceData failed:", res.error);
|
|
1062
|
-
}
|
|
1063
|
-
}
|
|
1064
|
-
|
|
1065
|
-
run();
|
|
1066
|
-
```
|
|
1067
|
-
|
|
1068
|
-
### Parameters
|
|
1069
|
-
|
|
1070
|
-
| Parameter | Type | Required | Description |
|
|
1071
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1072
|
-
| `request` | [operations.GetDisputeEvidenceDataRequest](../../models/operations/getdisputeevidencedatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1073
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1074
|
-
| `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. |
|
|
1075
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1076
|
-
|
|
1077
|
-
### Response
|
|
1078
|
-
|
|
1079
|
-
**Promise\<[operations.GetDisputeEvidenceDataResponse](../../models/operations/getdisputeevidencedataresponse.md)\>**
|
|
1080
|
-
|
|
1081
|
-
### Errors
|
|
1082
|
-
|
|
1083
|
-
| Error Type | Status Code | Content Type |
|
|
1084
|
-
| --------------- | --------------- | --------------- |
|
|
1085
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|