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
|
@@ -6,255 +6,141 @@ OpenAPI specification for Repzo Inventory Adjustment Reason 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
|
### `/inventory-adjustment-reason`
|
|
28
20
|
|
|
29
|
-
|
|
30
21
|
#### GET /inventory-adjustment-reason
|
|
31
22
|
|
|
32
23
|
**Summary:** Find inventory adjustment reasons
|
|
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 inventory adjustment reasons |
|
|
45
|
-
|
|
46
|
-
|
|
28
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
47
29
|
|
|
48
30
|
|
|
31
|
+
| `params` | query | object | No | Query parameters for filtering inventory adjustment reasons |
|
|
49
32
|
|
|
50
33
|
##### Responses
|
|
51
34
|
|
|
52
|
-
|
|
53
35
|
**200** - A list of inventory adjustment reasons
|
|
54
36
|
|
|
55
|
-
|
|
56
|
-
|
|
57
37
|
Content-Type: `application/json`
|
|
58
38
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
39
|
---
|
|
64
40
|
|
|
65
|
-
|
|
66
41
|
#### POST /inventory-adjustment-reason
|
|
67
42
|
|
|
68
43
|
**Summary:** Create an inventory adjustment reason
|
|
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** - Inventory adjustment reason 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
|
### `/inventory-adjustment-reason/{id}`
|
|
107
60
|
|
|
108
|
-
|
|
109
61
|
#### GET /inventory-adjustment-reason/{id}
|
|
110
62
|
|
|
111
63
|
**Summary:** Get an inventory adjustment reason 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** - Inventory adjustment reason 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 /inventory-adjustment-reason/{id}
|
|
146
82
|
|
|
147
83
|
**Summary:** Update an inventory adjustment reason
|
|
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** - Inventory adjustment reason updated
|
|
180
102
|
|
|
181
|
-
|
|
182
|
-
|
|
183
103
|
Content-Type: `application/json`
|
|
184
104
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
105
|
---
|
|
190
106
|
|
|
191
|
-
|
|
192
107
|
#### DELETE /inventory-adjustment-reason/{id}
|
|
193
108
|
|
|
194
109
|
**Summary:** Remove an inventory adjustment reason
|
|
195
110
|
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
111
|
##### Parameters
|
|
202
112
|
|
|
203
113
|
| Name | Location | Type | Required | Description |
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
| `id` | path | string | Yes | No description |
|
|
207
|
-
|
|
208
|
-
|
|
114
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
209
115
|
|
|
210
116
|
|
|
117
|
+
| `id` | path | string | Yes | No description |
|
|
211
118
|
|
|
212
119
|
##### Responses
|
|
213
120
|
|
|
214
|
-
|
|
215
121
|
**200** - Inventory adjustment reason removed
|
|
216
122
|
|
|
217
|
-
|
|
218
|
-
|
|
219
123
|
Content-Type: `application/json`
|
|
220
124
|
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
125
|
---
|
|
226
126
|
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
127
|
## Data Models
|
|
231
128
|
|
|
232
|
-
|
|
233
|
-
|
|
234
129
|
### InventoryAdjustmentReasonFindResult
|
|
235
130
|
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
131
|
| Property | Type | Required | Description |
|
|
240
|
-
|
|
132
|
+
| -------- | ---- | -------- | ----------- |
|
|
133
|
+
|
|
241
134
|
|
|
242
135
|
| `data` | array | No | No description |
|
|
243
136
|
|
|
244
137
|
| `meta` | object | No | No description |
|
|
245
138
|
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
139
|
### InventoryAdjustmentReasonCreateBody
|
|
252
140
|
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
141
|
| Property | Type | Required | Description |
|
|
257
|
-
|
|
142
|
+
| -------- | ---- | -------- | ----------- |
|
|
143
|
+
|
|
258
144
|
|
|
259
145
|
| `name` | string | No | No description |
|
|
260
146
|
|
|
@@ -262,48 +148,27 @@ Content-Type: `application/json`
|
|
|
262
148
|
|
|
263
149
|
| `disabled` | boolean | No | No description |
|
|
264
150
|
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
151
|
### InventoryAdjustmentReasonCreateResult
|
|
271
152
|
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
153
|
| Property | Type | Required | Description |
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
| `data` | object | No | No description |
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
154
|
+
| -------- | ---- | -------- | ----------- |
|
|
282
155
|
|
|
283
156
|
|
|
157
|
+
| `data` | object | No | No description |
|
|
284
158
|
|
|
285
159
|
### InventoryAdjustmentReasonGetResult
|
|
286
160
|
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
161
|
| Property | Type | Required | Description |
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
| `data` | object | No | No description |
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
162
|
+
| -------- | ---- | -------- | ----------- |
|
|
297
163
|
|
|
298
164
|
|
|
165
|
+
| `data` | object | No | No description |
|
|
299
166
|
|
|
300
167
|
### InventoryAdjustmentReasonUpdateBody
|
|
301
168
|
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
169
|
| Property | Type | Required | Description |
|
|
306
|
-
|
|
170
|
+
| -------- | ---- | -------- | ----------- |
|
|
171
|
+
|
|
307
172
|
|
|
308
173
|
| `name` | string | No | No description |
|
|
309
174
|
|
|
@@ -311,48 +176,27 @@ Content-Type: `application/json`
|
|
|
311
176
|
|
|
312
177
|
| `disabled` | boolean | No | No description |
|
|
313
178
|
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
179
|
### InventoryAdjustmentReasonUpdateResult
|
|
320
180
|
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
181
|
| Property | Type | Required | Description |
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
| `data` | object | No | No description |
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
182
|
+
| -------- | ---- | -------- | ----------- |
|
|
331
183
|
|
|
332
184
|
|
|
185
|
+
| `data` | object | No | No description |
|
|
333
186
|
|
|
334
187
|
### InventoryAdjustmentReasonRemoveResult
|
|
335
188
|
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
189
|
| Property | Type | Required | Description |
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
| `success` | boolean | No | No description |
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
190
|
+
| -------- | ---- | -------- | ----------- |
|
|
346
191
|
|
|
347
192
|
|
|
193
|
+
| `success` | boolean | No | No description |
|
|
348
194
|
|
|
349
195
|
### InventoryAdjustmentReason
|
|
350
196
|
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
197
|
| Property | Type | Required | Description |
|
|
355
|
-
|
|
198
|
+
| -------- | ---- | -------- | ----------- |
|
|
199
|
+
|
|
356
200
|
|
|
357
201
|
| `_id` | string | No | No description |
|
|
358
202
|
|
|
@@ -366,13 +210,6 @@ Content-Type: `application/json`
|
|
|
366
210
|
|
|
367
211
|
| `updatedAt` | string | No | No description |
|
|
368
212
|
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
213
|
## TypeScript Usage
|
|
377
214
|
|
|
378
|
-
See [inventory-adjustment-reason-examples.md](./inventory-adjustment-reason-examples.md) for detailed TypeScript usage examples.
|
|
215
|
+
See [inventory-adjustment-reason-examples.md](./inventory-adjustment-reason-examples.md) for detailed TypeScript usage examples.
|
|
@@ -11,48 +11,41 @@ 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 inventory items
|
|
26
24
|
|
|
27
|
-
|
|
28
|
-
|
|
29
25
|
```typescript
|
|
30
|
-
|
|
31
26
|
// GET /inventory
|
|
32
27
|
|
|
33
28
|
const params = {
|
|
34
|
-
|
|
35
29
|
params: null, // Query parameters for filtering inventory items
|
|
36
|
-
|
|
37
30
|
};
|
|
38
31
|
|
|
39
|
-
const result = await fetch(
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
32
|
+
const result = await fetch(
|
|
33
|
+
`${baseURL}/inventory?${new URLSearchParams(params)}`,
|
|
34
|
+
{
|
|
35
|
+
method: "GET",
|
|
36
|
+
headers: {
|
|
37
|
+
Authorization: `Bearer ${apiKey}`,
|
|
38
|
+
"Content-Type": "application/json",
|
|
39
|
+
},
|
|
44
40
|
}
|
|
45
|
-
|
|
41
|
+
);
|
|
46
42
|
|
|
47
43
|
const data = await result.json();
|
|
48
44
|
console.log(data);
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
45
|
```
|
|
53
46
|
|
|
54
|
-
|
|
55
47
|
**Expected Response:**
|
|
48
|
+
|
|
56
49
|
```json
|
|
57
50
|
{
|
|
58
51
|
"success": true,
|
|
@@ -62,27 +55,21 @@ console.log(data);
|
|
|
62
55
|
}
|
|
63
56
|
```
|
|
64
57
|
|
|
65
|
-
|
|
66
58
|
---
|
|
67
59
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
60
|
## Using with Repzo SDK Service Types
|
|
72
61
|
|
|
73
62
|
The Repzo SDK provides TypeScript interfaces for type safety:
|
|
74
63
|
|
|
75
64
|
```typescript
|
|
76
|
-
import { Service } from
|
|
65
|
+
import { Service } from "repzo";
|
|
77
66
|
|
|
78
67
|
// Example using SDK types
|
|
79
68
|
|
|
80
|
-
|
|
81
69
|
async function example() {
|
|
82
70
|
// Use the Service.Inventory types for better type safety
|
|
83
71
|
// This provides intellisense and compile-time type checking
|
|
84
72
|
}
|
|
85
|
-
|
|
86
73
|
```
|
|
87
74
|
|
|
88
75
|
## Error Handling
|
|
@@ -90,11 +77,11 @@ async function example() {
|
|
|
90
77
|
```typescript
|
|
91
78
|
try {
|
|
92
79
|
const result = await fetch(`${baseURL}/endpoint`, {
|
|
93
|
-
method:
|
|
80
|
+
method: "GET",
|
|
94
81
|
headers: {
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
}
|
|
82
|
+
Authorization: `Bearer ${apiKey}`,
|
|
83
|
+
"Content-Type": "application/json",
|
|
84
|
+
},
|
|
98
85
|
});
|
|
99
86
|
|
|
100
87
|
if (!result.ok) {
|
|
@@ -102,14 +89,14 @@ try {
|
|
|
102
89
|
}
|
|
103
90
|
|
|
104
91
|
const data = await result.json();
|
|
105
|
-
|
|
92
|
+
|
|
106
93
|
if (!data.success) {
|
|
107
|
-
throw new Error(data.error ||
|
|
94
|
+
throw new Error(data.error || "API request failed");
|
|
108
95
|
}
|
|
109
|
-
|
|
96
|
+
|
|
110
97
|
return data.data;
|
|
111
98
|
} catch (error) {
|
|
112
|
-
console.error(
|
|
99
|
+
console.error("API request failed:", error);
|
|
113
100
|
throw error;
|
|
114
101
|
}
|
|
115
102
|
```
|
|
@@ -125,18 +112,21 @@ const params = {
|
|
|
125
112
|
// other filters...
|
|
126
113
|
};
|
|
127
114
|
|
|
128
|
-
const result = await fetch(
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
115
|
+
const result = await fetch(
|
|
116
|
+
`${baseURL}/endpoint?${new URLSearchParams(params)}`,
|
|
117
|
+
{
|
|
118
|
+
method: "GET",
|
|
119
|
+
headers: {
|
|
120
|
+
Authorization: `Bearer ${apiKey}`,
|
|
121
|
+
"Content-Type": "application/json",
|
|
122
|
+
},
|
|
133
123
|
}
|
|
134
|
-
|
|
124
|
+
);
|
|
135
125
|
|
|
136
126
|
const data = await result.json();
|
|
137
127
|
|
|
138
128
|
// Access pagination info
|
|
139
|
-
console.log(
|
|
140
|
-
console.log(
|
|
141
|
-
console.log(
|
|
142
|
-
```
|
|
129
|
+
console.log("Total items:", data.paging.total);
|
|
130
|
+
console.log("Current page:", data.paging.page);
|
|
131
|
+
console.log("Total pages:", data.paging.pages);
|
|
132
|
+
```
|
package/docs/api/inventory.md
CHANGED
|
@@ -6,93 +6,55 @@ OpenAPI specification for Repzo Inventory 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
|
### `/inventory`
|
|
28
20
|
|
|
29
|
-
|
|
30
21
|
#### GET /inventory
|
|
31
22
|
|
|
32
23
|
**Summary:** Find inventory items
|
|
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 inventory items |
|
|
45
|
-
|
|
46
|
-
|
|
28
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
47
29
|
|
|
48
30
|
|
|
31
|
+
| `params` | query | object | No | Query parameters for filtering inventory items |
|
|
49
32
|
|
|
50
33
|
##### Responses
|
|
51
34
|
|
|
52
|
-
|
|
53
35
|
**200** - A list of inventory items
|
|
54
36
|
|
|
55
|
-
|
|
56
|
-
|
|
57
37
|
Content-Type: `application/json`
|
|
58
38
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
39
|
---
|
|
64
40
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
41
|
## Data Models
|
|
69
42
|
|
|
70
|
-
|
|
71
|
-
|
|
72
43
|
### InventoryFindResult
|
|
73
44
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
45
|
| Property | Type | Required | Description |
|
|
78
|
-
|
|
46
|
+
| -------- | ---- | -------- | ----------- |
|
|
47
|
+
|
|
79
48
|
|
|
80
49
|
| `data` | array | No | No description |
|
|
81
50
|
|
|
82
51
|
| `meta` | object | No | No description |
|
|
83
52
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
53
|
### Inventory
|
|
90
54
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
55
|
| Property | Type | Required | Description |
|
|
95
|
-
|
|
56
|
+
| -------- | ---- | -------- | ----------- |
|
|
57
|
+
|
|
96
58
|
|
|
97
59
|
| `_id` | string | No | No description |
|
|
98
60
|
|
|
@@ -116,13 +78,6 @@ Content-Type: `application/json`
|
|
|
116
78
|
|
|
117
79
|
| `updatedAt` | string | No | No description |
|
|
118
80
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
81
|
## TypeScript Usage
|
|
127
82
|
|
|
128
|
-
See [inventory-examples.md](./inventory-examples.md) for detailed TypeScript usage examples.
|
|
83
|
+
See [inventory-examples.md](./inventory-examples.md) for detailed TypeScript usage examples.
|