repzo 1.0.141 → 1.0.143
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/docs/README.md +16 -315
- package/docs/api/activity-ai-sales-order-examples.md +63 -112
- package/docs/api/activity-ai-sales-order.md +15 -215
- package/docs/api/activity-feedback-examples.md +82 -136
- package/docs/api/activity-feedback-v2-examples.md +86 -138
- package/docs/api/activity-feedback-v2.md +19 -263
- package/docs/api/activity-feedback.md +19 -263
- package/docs/api/activity-storecheck-examples.md +62 -101
- package/docs/api/activity-storecheck.md +13 -186
- package/docs/api/adjust-account-examples.md +50 -78
- package/docs/api/adjust-account.md +12 -117
- package/docs/api/adjust-inventory-examples.md +50 -78
- package/docs/api/adjust-inventory.md +16 -121
- package/docs/api/approval-request-examples.md +58 -97
- package/docs/api/approval-request.md +26 -189
- package/docs/api/approvals-examples.md +58 -97
- package/docs/api/approvals.md +26 -189
- package/docs/api/asset-examples.md +53 -95
- package/docs/api/asset-part-examples.md +62 -101
- package/docs/api/asset-part-receival-examples.md +62 -101
- package/docs/api/asset-part-receival.md +13 -186
- package/docs/api/asset-part-transfer-examples.md +63 -112
- package/docs/api/asset-part-transfer.md +15 -215
- package/docs/api/asset-part-type-examples.md +62 -101
- package/docs/api/asset-part-type.md +13 -186
- package/docs/api/asset-part-unit-examples.md +62 -101
- package/docs/api/asset-part-unit.md +13 -186
- package/docs/api/asset-part.md +13 -186
- package/docs/api/asset-type-examples.md +58 -97
- package/docs/api/asset-type.md +26 -189
- package/docs/api/asset-unit-examples.md +80 -147
- package/docs/api/asset-unit.md +19 -306
- package/docs/api/asset.md +26 -189
- package/docs/api/banks-examples.md +53 -95
- package/docs/api/banks.md +26 -189
- package/docs/api/bankslists-examples.md +58 -97
- package/docs/api/bankslists.md +26 -189
- package/docs/api/brand-examples.md +58 -97
- package/docs/api/brand.md +18 -181
- package/docs/api/category-examples.md +58 -97
- package/docs/api/category.md +18 -181
- package/docs/api/checks-examples.md +45 -76
- package/docs/api/checks.md +12 -117
- package/docs/api/client-channel-examples.md +62 -101
- package/docs/api/client-channel.md +20 -207
- package/docs/api/client-contact-examples.md +62 -101
- package/docs/api/client-contact.md +25 -233
- package/docs/api/client-examples.md +53 -95
- package/docs/api/client-location-examples.md +71 -126
- package/docs/api/client-location.md +19 -275
- package/docs/api/client.md +18 -181
- package/docs/api/contract-examples.md +58 -97
- package/docs/api/contract-installment-examples.md +84 -148
- package/docs/api/contract-installment.md +21 -303
- package/docs/api/contract.md +26 -189
- package/docs/api/custom-list-examples.md +58 -97
- package/docs/api/custom-list-item-examples.md +58 -97
- package/docs/api/custom-list-item.md +26 -189
- package/docs/api/custom-list.md +26 -189
- package/docs/api/custom-status-examples.md +58 -97
- package/docs/api/custom-status.md +26 -189
- package/docs/api/day-examples.md +45 -76
- package/docs/api/day.md +12 -117
- package/docs/api/feedback-options-examples.md +90 -153
- package/docs/api/feedback-options.md +23 -307
- package/docs/api/fullinvoices-examples.md +51 -83
- package/docs/api/fullinvoices.md +22 -162
- package/docs/api/index.md +99 -705
- package/docs/api/integration-action-log-examples.md +62 -101
- package/docs/api/integration-action-log.md +13 -186
- package/docs/api/integration-app-examples.md +51 -83
- package/docs/api/integration-app.md +16 -156
- package/docs/api/integration-command-log-examples.md +62 -101
- package/docs/api/integration-command-log.md +13 -186
- package/docs/api/inventory-adjustment-reason-examples.md +58 -97
- package/docs/api/inventory-adjustment-reason.md +26 -189
- package/docs/api/inventory-examples.md +35 -45
- package/docs/api/inventory.md +8 -53
- package/docs/api/mail-unsubscribe-examples.md +69 -124
- package/docs/api/mail-unsubscribe.md +13 -251
- package/docs/api/measureunit-examples.md +58 -97
- package/docs/api/measureunit-family-examples.md +58 -97
- package/docs/api/measureunit-family.md +18 -188
- package/docs/api/measureunit.md +20 -190
- package/docs/api/media-examples.md +53 -95
- package/docs/api/media-storage-examples.md +58 -97
- package/docs/api/media-storage.md +18 -181
- package/docs/api/media.md +18 -181
- package/docs/api/msl-examples.md +53 -95
- package/docs/api/msl-products-examples.md +58 -97
- package/docs/api/msl-products.md +26 -189
- package/docs/api/msl.md +26 -189
- package/docs/api/ocr-invoice-job-examples.md +74 -132
- package/docs/api/ocr-invoice-job-group-examples.md +73 -121
- package/docs/api/ocr-invoice-job-group.md +15 -215
- package/docs/api/ocr-invoice-job-page-examples.md +63 -112
- package/docs/api/ocr-invoice-job-page.md +15 -215
- package/docs/api/ocr-invoice-job-template-examples.md +62 -101
- package/docs/api/ocr-invoice-job-template.md +13 -186
- package/docs/api/ocr-invoice-job.md +19 -253
- package/docs/api/patch-action-examples.md +63 -112
- package/docs/api/patch-action.md +15 -215
- package/docs/api/payment-terms-examples.md +58 -97
- package/docs/api/payment-terms.md +28 -198
- package/docs/api/payments-examples.md +51 -83
- package/docs/api/payments.md +22 -162
- package/docs/api/pricelist-examples.md +58 -97
- package/docs/api/pricelist-item-examples.md +58 -97
- package/docs/api/pricelist-item.md +24 -208
- package/docs/api/pricelist.md +18 -181
- package/docs/api/product-examples.md +58 -97
- package/docs/api/product-group-examples.md +58 -97
- package/docs/api/product-group.md +18 -181
- package/docs/api/product-modifiers-group-examples.md +70 -125
- package/docs/api/product-modifiers-group.md +19 -275
- package/docs/api/product.md +20 -190
- package/docs/api/proforma-examples.md +51 -83
- package/docs/api/proforma.md +22 -162
- package/docs/api/quick-convert-to-pdf-examples.md +30 -41
- package/docs/api/quick-convert-to-pdf.md +6 -56
- package/docs/api/receiving-material-examples.md +51 -83
- package/docs/api/receiving-material.md +16 -156
- package/docs/api/refund-examples.md +46 -81
- package/docs/api/refund.md +16 -156
- package/docs/api/rep-balance-summary-examples.md +36 -46
- package/docs/api/rep-balance-summary.md +6 -53
- package/docs/api/rep-examples.md +53 -95
- package/docs/api/rep.md +18 -181
- package/docs/api/return-asset-part-unit-examples.md +62 -101
- package/docs/api/return-asset-part-unit.md +13 -186
- package/docs/api/return-reason-examples.md +58 -97
- package/docs/api/return-reason.md +18 -181
- package/docs/api/route-examples.md +53 -95
- package/docs/api/route.md +18 -181
- package/docs/api/safe-invoice-serial-counter-examples.md +72 -127
- package/docs/api/safe-invoice-serial-counter.md +17 -266
- package/docs/api/settings-examples.md +47 -70
- package/docs/api/settings.md +18 -123
- package/docs/api/settlement-examples.md +50 -78
- package/docs/api/settlement.md +12 -117
- package/docs/api/speciality-examples.md +70 -125
- package/docs/api/speciality.md +17 -266
- package/docs/api/store-asset-part-unit-examples.md +62 -101
- package/docs/api/store-asset-part-unit.md +13 -186
- package/docs/api/storecheck-template-examples.md +58 -97
- package/docs/api/storecheck-template.md +18 -181
- package/docs/api/subcategory-examples.md +58 -97
- package/docs/api/subcategory.md +18 -181
- package/docs/api/supplier-examples.md +58 -97
- package/docs/api/supplier.md +26 -189
- package/docs/api/svix-integration-examples.md +62 -101
- package/docs/api/svix-integration.md +13 -186
- package/docs/api/tag-examples.md +53 -95
- package/docs/api/tag.md +18 -181
- package/docs/api/tax-examples.md +53 -95
- package/docs/api/tax.md +18 -181
- package/docs/api/team-examples.md +53 -95
- package/docs/api/team.md +18 -181
- package/docs/api/transfer-examples.md +51 -83
- package/docs/api/transfer.md +16 -156
- package/docs/api/update-integration-meta-examples.md +63 -112
- package/docs/api/update-integration-meta.md +15 -215
- package/docs/api/variant-examples.md +58 -97
- package/docs/api/variant.md +20 -183
- package/docs/api/visit-examples.md +46 -81
- package/docs/api/visit.md +22 -162
- package/docs/api/warehouse-examples.md +58 -97
- package/docs/api/warehouse.md +18 -181
- package/docs/api/workorder-category-examples.md +76 -141
- package/docs/api/workorder-category.md +19 -305
- package/docs/api/workorder-examples.md +58 -97
- package/docs/api/workorder-portal-examples.md +75 -132
- package/docs/api/workorder-portal-link-examples.md +70 -145
- package/docs/api/workorder-portal-link.md +23 -336
- package/docs/api/workorder-portal.md +19 -271
- package/docs/api/workorder-request-examples.md +58 -97
- package/docs/api/workorder-request.md +26 -189
- package/docs/api/workorder.md +26 -189
- package/docs/generated/index.html +1 -1
- package/docs/generated/repzo-api-complete.yaml +2585 -2585
- package/lib/index.d.ts +180 -0
- package/lib/index.js +90 -0
- package/lib/types/index.d.ts +13393 -14636
- package/package.json +3 -4
- package/src/types/index.ts +14 -1
|
@@ -11,48 +11,38 @@ npm install repzo
|
|
|
11
11
|
## Basic Setup
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import { Service } from
|
|
14
|
+
import { Service } from "repzo";
|
|
15
15
|
|
|
16
16
|
// Initialize with your API key
|
|
17
|
-
const apiKey =
|
|
18
|
-
const baseURL =
|
|
17
|
+
const apiKey = "your-api-key";
|
|
18
|
+
const baseURL = "https://api.repzo.me/v1";
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
## API Usage Examples
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
23
|
### Find refunds
|
|
26
24
|
|
|
27
|
-
|
|
28
|
-
|
|
29
25
|
```typescript
|
|
30
|
-
|
|
31
26
|
// GET /refund
|
|
32
27
|
|
|
33
28
|
const params = {
|
|
34
|
-
|
|
35
29
|
params: null, // Query parameters for filtering refunds
|
|
36
|
-
|
|
37
30
|
};
|
|
38
31
|
|
|
39
32
|
const result = await fetch(`${baseURL}/refund?${new URLSearchParams(params)}`, {
|
|
40
|
-
method:
|
|
33
|
+
method: "GET",
|
|
41
34
|
headers: {
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
}
|
|
35
|
+
Authorization: `Bearer ${apiKey}`,
|
|
36
|
+
"Content-Type": "application/json",
|
|
37
|
+
},
|
|
45
38
|
});
|
|
46
39
|
|
|
47
40
|
const data = await result.json();
|
|
48
41
|
console.log(data);
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
42
|
```
|
|
53
43
|
|
|
54
|
-
|
|
55
44
|
**Expected Response:**
|
|
45
|
+
|
|
56
46
|
```json
|
|
57
47
|
{
|
|
58
48
|
"success": true,
|
|
@@ -62,16 +52,11 @@ console.log(data);
|
|
|
62
52
|
}
|
|
63
53
|
```
|
|
64
54
|
|
|
65
|
-
|
|
66
55
|
---
|
|
67
56
|
|
|
68
|
-
|
|
69
57
|
### Create a refund
|
|
70
58
|
|
|
71
|
-
|
|
72
|
-
|
|
73
59
|
```typescript
|
|
74
|
-
|
|
75
60
|
// POST /refund
|
|
76
61
|
|
|
77
62
|
const requestBody = {
|
|
@@ -80,59 +65,46 @@ const requestBody = {
|
|
|
80
65
|
};
|
|
81
66
|
|
|
82
67
|
const result = await fetch(`${baseURL}/refund`, {
|
|
83
|
-
method:
|
|
68
|
+
method: "POST",
|
|
84
69
|
headers: {
|
|
85
|
-
|
|
86
|
-
|
|
70
|
+
Authorization: `Bearer ${apiKey}`,
|
|
71
|
+
"Content-Type": "application/json",
|
|
87
72
|
},
|
|
88
|
-
body: JSON.stringify(requestBody)
|
|
73
|
+
body: JSON.stringify(requestBody),
|
|
89
74
|
});
|
|
90
75
|
|
|
91
76
|
const data = await result.json();
|
|
92
77
|
console.log(data);
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
78
|
```
|
|
97
79
|
|
|
98
|
-
|
|
99
|
-
|
|
100
80
|
---
|
|
101
81
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
82
|
### Get a refund by ID
|
|
106
83
|
|
|
107
|
-
|
|
108
|
-
|
|
109
84
|
```typescript
|
|
110
|
-
|
|
111
85
|
// GET /refund/{id}
|
|
112
86
|
|
|
113
87
|
const params = {
|
|
114
|
-
|
|
115
|
-
id: 'example-value', // No description
|
|
116
|
-
|
|
88
|
+
id: "example-value", // No description
|
|
117
89
|
};
|
|
118
90
|
|
|
119
|
-
const result = await fetch(
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
91
|
+
const result = await fetch(
|
|
92
|
+
`${baseURL}/refund/{id}?${new URLSearchParams(params)}`,
|
|
93
|
+
{
|
|
94
|
+
method: "GET",
|
|
95
|
+
headers: {
|
|
96
|
+
Authorization: `Bearer ${apiKey}`,
|
|
97
|
+
"Content-Type": "application/json",
|
|
98
|
+
},
|
|
124
99
|
}
|
|
125
|
-
|
|
100
|
+
);
|
|
126
101
|
|
|
127
102
|
const data = await result.json();
|
|
128
103
|
console.log(data);
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
104
|
```
|
|
133
105
|
|
|
134
|
-
|
|
135
106
|
**Expected Response:**
|
|
107
|
+
|
|
136
108
|
```json
|
|
137
109
|
{
|
|
138
110
|
"success": true,
|
|
@@ -142,20 +114,16 @@ console.log(data);
|
|
|
142
114
|
}
|
|
143
115
|
```
|
|
144
116
|
|
|
145
|
-
|
|
146
117
|
---
|
|
147
118
|
|
|
148
|
-
|
|
149
119
|
### Update a refund
|
|
150
120
|
|
|
151
|
-
|
|
152
|
-
|
|
153
121
|
```typescript
|
|
154
122
|
|
|
155
123
|
```
|
|
156
124
|
|
|
157
|
-
|
|
158
125
|
**Expected Response:**
|
|
126
|
+
|
|
159
127
|
```json
|
|
160
128
|
{
|
|
161
129
|
"success": true,
|
|
@@ -165,27 +133,21 @@ console.log(data);
|
|
|
165
133
|
}
|
|
166
134
|
```
|
|
167
135
|
|
|
168
|
-
|
|
169
136
|
---
|
|
170
137
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
138
|
## Using with Repzo SDK Service Types
|
|
175
139
|
|
|
176
140
|
The Repzo SDK provides TypeScript interfaces for type safety:
|
|
177
141
|
|
|
178
142
|
```typescript
|
|
179
|
-
import { Service } from
|
|
143
|
+
import { Service } from "repzo";
|
|
180
144
|
|
|
181
145
|
// Example using SDK types
|
|
182
146
|
|
|
183
|
-
|
|
184
147
|
async function example() {
|
|
185
148
|
// Use the Service.Refund types for better type safety
|
|
186
149
|
// This provides intellisense and compile-time type checking
|
|
187
150
|
}
|
|
188
|
-
|
|
189
151
|
```
|
|
190
152
|
|
|
191
153
|
## Error Handling
|
|
@@ -193,11 +155,11 @@ async function example() {
|
|
|
193
155
|
```typescript
|
|
194
156
|
try {
|
|
195
157
|
const result = await fetch(`${baseURL}/endpoint`, {
|
|
196
|
-
method:
|
|
158
|
+
method: "GET",
|
|
197
159
|
headers: {
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
}
|
|
160
|
+
Authorization: `Bearer ${apiKey}`,
|
|
161
|
+
"Content-Type": "application/json",
|
|
162
|
+
},
|
|
201
163
|
});
|
|
202
164
|
|
|
203
165
|
if (!result.ok) {
|
|
@@ -205,14 +167,14 @@ try {
|
|
|
205
167
|
}
|
|
206
168
|
|
|
207
169
|
const data = await result.json();
|
|
208
|
-
|
|
170
|
+
|
|
209
171
|
if (!data.success) {
|
|
210
|
-
throw new Error(data.error ||
|
|
172
|
+
throw new Error(data.error || "API request failed");
|
|
211
173
|
}
|
|
212
|
-
|
|
174
|
+
|
|
213
175
|
return data.data;
|
|
214
176
|
} catch (error) {
|
|
215
|
-
console.error(
|
|
177
|
+
console.error("API request failed:", error);
|
|
216
178
|
throw error;
|
|
217
179
|
}
|
|
218
180
|
```
|
|
@@ -228,18 +190,21 @@ const params = {
|
|
|
228
190
|
// other filters...
|
|
229
191
|
};
|
|
230
192
|
|
|
231
|
-
const result = await fetch(
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
193
|
+
const result = await fetch(
|
|
194
|
+
`${baseURL}/endpoint?${new URLSearchParams(params)}`,
|
|
195
|
+
{
|
|
196
|
+
method: "GET",
|
|
197
|
+
headers: {
|
|
198
|
+
Authorization: `Bearer ${apiKey}`,
|
|
199
|
+
"Content-Type": "application/json",
|
|
200
|
+
},
|
|
236
201
|
}
|
|
237
|
-
|
|
202
|
+
);
|
|
238
203
|
|
|
239
204
|
const data = await result.json();
|
|
240
205
|
|
|
241
206
|
// Access pagination info
|
|
242
|
-
console.log(
|
|
243
|
-
console.log(
|
|
244
|
-
console.log(
|
|
245
|
-
```
|
|
207
|
+
console.log("Total items:", data.paging.total);
|
|
208
|
+
console.log("Current page:", data.paging.page);
|
|
209
|
+
console.log("Total pages:", data.paging.pages);
|
|
210
|
+
```
|
package/docs/api/refund.md
CHANGED
|
@@ -6,204 +6,113 @@ OpenAPI specification for Repzo Refund endpoints.
|
|
|
6
6
|
|
|
7
7
|
## Overview
|
|
8
8
|
|
|
9
|
-
|
|
10
9
|
### Base URLs
|
|
11
10
|
|
|
12
|
-
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
11
|
+
- \*\*\*\*: `https://sv.api.repzo.me`
|
|
17
12
|
|
|
18
13
|
## Authentication
|
|
19
14
|
|
|
20
|
-
|
|
21
15
|
No authentication required.
|
|
22
16
|
|
|
23
|
-
|
|
24
17
|
## Endpoints
|
|
25
18
|
|
|
26
|
-
|
|
27
19
|
### `/refund`
|
|
28
20
|
|
|
29
|
-
|
|
30
21
|
#### GET /refund
|
|
31
22
|
|
|
32
23
|
**Summary:** Find refunds
|
|
33
24
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
25
|
##### Parameters
|
|
40
26
|
|
|
41
27
|
| Name | Location | Type | Required | Description |
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
| `params` | query | object | No | Query parameters for filtering refunds |
|
|
45
|
-
|
|
46
|
-
|
|
28
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
47
29
|
|
|
48
30
|
|
|
31
|
+
| `params` | query | object | No | Query parameters for filtering refunds |
|
|
49
32
|
|
|
50
33
|
##### Responses
|
|
51
34
|
|
|
52
|
-
|
|
53
35
|
**200** - A list of refunds
|
|
54
36
|
|
|
55
|
-
|
|
56
|
-
|
|
57
37
|
Content-Type: `application/json`
|
|
58
38
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
39
|
---
|
|
64
40
|
|
|
65
|
-
|
|
66
41
|
#### POST /refund
|
|
67
42
|
|
|
68
43
|
**Summary:** Create a refund
|
|
69
44
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
45
|
##### Request Body
|
|
78
46
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
47
|
**Content Types:**
|
|
83
48
|
|
|
84
49
|
- `application/json`
|
|
85
50
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
51
|
##### Responses
|
|
90
52
|
|
|
91
|
-
|
|
92
53
|
**201** - Refund created
|
|
93
54
|
|
|
94
|
-
|
|
95
|
-
|
|
96
55
|
Content-Type: `application/json`
|
|
97
56
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
57
|
---
|
|
103
58
|
|
|
104
|
-
|
|
105
|
-
|
|
106
59
|
### `/refund/{id}`
|
|
107
60
|
|
|
108
|
-
|
|
109
61
|
#### GET /refund/{id}
|
|
110
62
|
|
|
111
63
|
**Summary:** Get a refund by ID
|
|
112
64
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
65
|
##### Parameters
|
|
119
66
|
|
|
120
67
|
| Name | Location | Type | Required | Description |
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
| `id` | path | string | Yes | No description |
|
|
124
|
-
|
|
125
|
-
|
|
68
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
126
69
|
|
|
127
70
|
|
|
71
|
+
| `id` | path | string | Yes | No description |
|
|
128
72
|
|
|
129
73
|
##### Responses
|
|
130
74
|
|
|
131
|
-
|
|
132
75
|
**200** - Refund details
|
|
133
76
|
|
|
134
|
-
|
|
135
|
-
|
|
136
77
|
Content-Type: `application/json`
|
|
137
78
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
79
|
---
|
|
143
80
|
|
|
144
|
-
|
|
145
81
|
#### PUT /refund/{id}
|
|
146
82
|
|
|
147
83
|
**Summary:** Update a refund
|
|
148
84
|
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
85
|
##### Parameters
|
|
155
86
|
|
|
156
87
|
| Name | Location | Type | Required | Description |
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
| `id` | path | string | Yes | No description |
|
|
160
|
-
|
|
88
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
161
89
|
|
|
162
90
|
|
|
91
|
+
| `id` | path | string | Yes | No description |
|
|
163
92
|
|
|
164
93
|
##### Request Body
|
|
165
94
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
95
|
**Content Types:**
|
|
170
96
|
|
|
171
97
|
- `application/json`
|
|
172
98
|
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
99
|
##### Responses
|
|
177
100
|
|
|
178
|
-
|
|
179
101
|
**200** - Refund updated
|
|
180
102
|
|
|
181
|
-
|
|
182
|
-
|
|
183
103
|
Content-Type: `application/json`
|
|
184
104
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
105
|
---
|
|
190
106
|
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
107
|
## Data Models
|
|
195
108
|
|
|
196
|
-
|
|
197
|
-
|
|
198
109
|
### RefundFindResult
|
|
199
110
|
|
|
200
|
-
|
|
201
111
|
Result of finding refunds
|
|
202
112
|
|
|
203
|
-
|
|
204
|
-
|
|
205
113
|
| Property | Type | Required | Description |
|
|
206
|
-
|
|
114
|
+
| -------- | ---- | -------- | ----------- |
|
|
115
|
+
|
|
207
116
|
|
|
208
117
|
| `data` | array | No | No description |
|
|
209
118
|
|
|
@@ -217,20 +126,13 @@ Result of finding refunds
|
|
|
217
126
|
|
|
218
127
|
| `per_page` | number | No | Number of refunds per page |
|
|
219
128
|
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
129
|
### RefundSchema
|
|
226
130
|
|
|
227
|
-
|
|
228
131
|
Refund schema
|
|
229
132
|
|
|
230
|
-
|
|
231
|
-
|
|
232
133
|
| Property | Type | Required | Description |
|
|
233
|
-
|
|
134
|
+
| -------- | ---- | -------- | ----------- |
|
|
135
|
+
|
|
234
136
|
|
|
235
137
|
| `_id` | string | No | Unique identifier for the refund |
|
|
236
138
|
|
|
@@ -264,20 +166,13 @@ Refund schema
|
|
|
264
166
|
|
|
265
167
|
| `__v` | number | No | Version number |
|
|
266
168
|
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
169
|
### RefundCreateBody
|
|
273
170
|
|
|
274
|
-
|
|
275
171
|
Body for creating a refund
|
|
276
172
|
|
|
277
|
-
|
|
278
|
-
|
|
279
173
|
| Property | Type | Required | Description |
|
|
280
|
-
|
|
174
|
+
| -------- | ---- | -------- | ----------- |
|
|
175
|
+
|
|
281
176
|
|
|
282
177
|
| `client` | string | Yes | Client ID associated with the refund |
|
|
283
178
|
|
|
@@ -297,42 +192,21 @@ Body for creating a refund
|
|
|
297
192
|
|
|
298
193
|
| `integration_meta` | object | No | Integration metadata |
|
|
299
194
|
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
195
|
### RefundCreateResult
|
|
306
196
|
|
|
307
|
-
|
|
308
197
|
Result of creating a refund
|
|
309
198
|
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
199
|
### RefundGetResult
|
|
317
200
|
|
|
318
|
-
|
|
319
201
|
Result of getting a refund
|
|
320
202
|
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
203
|
### RefundUpdateBody
|
|
328
204
|
|
|
329
|
-
|
|
330
205
|
Body for updating a refund
|
|
331
206
|
|
|
332
|
-
|
|
333
|
-
|
|
334
207
|
| Property | Type | Required | Description |
|
|
335
|
-
|
|
208
|
+
| -------- | ---- | -------- | ----------- |
|
|
209
|
+
|
|
336
210
|
|
|
337
211
|
| `status` | string | No | Status of the refund |
|
|
338
212
|
|
|
@@ -346,24 +220,10 @@ Body for updating a refund
|
|
|
346
220
|
|
|
347
221
|
| `integration_meta` | object | No | Integration metadata |
|
|
348
222
|
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
223
|
### RefundUpdateResult
|
|
355
224
|
|
|
356
|
-
|
|
357
225
|
Result of updating a refund
|
|
358
226
|
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
227
|
## TypeScript Usage
|
|
368
228
|
|
|
369
|
-
See [refund-examples.md](./refund-examples.md) for detailed TypeScript usage examples.
|
|
229
|
+
See [refund-examples.md](./refund-examples.md) for detailed TypeScript usage examples.
|