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,240 +6,133 @@ OpenAPI specification for Repzo Storecheck Template 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
|
### `/storecheck-template`
|
|
28
20
|
|
|
29
|
-
|
|
30
21
|
#### GET /storecheck-template
|
|
31
22
|
|
|
32
23
|
**Summary:** Find storecheck templates
|
|
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 storecheck templates |
|
|
45
|
-
|
|
46
|
-
|
|
28
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
47
29
|
|
|
48
30
|
|
|
31
|
+
| `params` | query | object | No | Query parameters for filtering storecheck templates |
|
|
49
32
|
|
|
50
33
|
##### Responses
|
|
51
34
|
|
|
52
|
-
|
|
53
35
|
**200** - A list of storecheck templates
|
|
54
36
|
|
|
55
|
-
|
|
56
|
-
|
|
57
37
|
Content-Type: `application/json`
|
|
58
38
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
39
|
---
|
|
64
40
|
|
|
65
|
-
|
|
66
41
|
#### POST /storecheck-template
|
|
67
42
|
|
|
68
43
|
**Summary:** Create a storecheck template
|
|
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** - Storecheck template 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
|
### `/storecheck-template/{id}`
|
|
107
60
|
|
|
108
|
-
|
|
109
61
|
#### GET /storecheck-template/{id}
|
|
110
62
|
|
|
111
63
|
**Summary:** Get a storecheck template 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** - Storecheck template 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 /storecheck-template/{id}
|
|
146
82
|
|
|
147
83
|
**Summary:** Update a storecheck template
|
|
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** - Storecheck template 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 /storecheck-template/{id}
|
|
193
108
|
|
|
194
109
|
**Summary:** Remove a storecheck template
|
|
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** - Storecheck template 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
|
### StorecheckTemplateFindResult
|
|
235
130
|
|
|
236
|
-
|
|
237
131
|
Result of finding storecheck templates
|
|
238
132
|
|
|
239
|
-
|
|
240
|
-
|
|
241
133
|
| Property | Type | Required | Description |
|
|
242
|
-
|
|
134
|
+
| -------- | ---- | -------- | ----------- |
|
|
135
|
+
|
|
243
136
|
|
|
244
137
|
| `data` | array | No | No description |
|
|
245
138
|
|
|
@@ -253,20 +146,13 @@ Result of finding storecheck templates
|
|
|
253
146
|
|
|
254
147
|
| `per_page` | number | No | Number of storecheck templates per page |
|
|
255
148
|
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
149
|
### StorecheckTemplateSchema
|
|
262
150
|
|
|
263
|
-
|
|
264
151
|
Storecheck template schema
|
|
265
152
|
|
|
266
|
-
|
|
267
|
-
|
|
268
153
|
| Property | Type | Required | Description |
|
|
269
|
-
|
|
154
|
+
| -------- | ---- | -------- | ----------- |
|
|
155
|
+
|
|
270
156
|
|
|
271
157
|
| `_id` | string | No | Unique identifier for the storecheck template |
|
|
272
158
|
|
|
@@ -298,20 +184,13 @@ Storecheck template schema
|
|
|
298
184
|
|
|
299
185
|
| `__v` | number | No | Version number |
|
|
300
186
|
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
187
|
### StorecheckTemplateCreateBody
|
|
307
188
|
|
|
308
|
-
|
|
309
189
|
Body for creating a storecheck template
|
|
310
190
|
|
|
311
|
-
|
|
312
|
-
|
|
313
191
|
| Property | Type | Required | Description |
|
|
314
|
-
|
|
192
|
+
| -------- | ---- | -------- | ----------- |
|
|
193
|
+
|
|
315
194
|
|
|
316
195
|
| `name` | string | Yes | Name of the storecheck template |
|
|
317
196
|
|
|
@@ -331,42 +210,21 @@ Body for creating a storecheck template
|
|
|
331
210
|
|
|
332
211
|
| `integration_meta` | object | No | Integration metadata |
|
|
333
212
|
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
213
|
### StorecheckTemplateCreateResult
|
|
340
214
|
|
|
341
|
-
|
|
342
215
|
Result of creating a storecheck template
|
|
343
216
|
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
217
|
### StorecheckTemplateGetResult
|
|
351
218
|
|
|
352
|
-
|
|
353
219
|
Result of getting a storecheck template
|
|
354
220
|
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
221
|
### StorecheckTemplateUpdateBody
|
|
362
222
|
|
|
363
|
-
|
|
364
223
|
Body for updating a storecheck template
|
|
365
224
|
|
|
366
|
-
|
|
367
|
-
|
|
368
225
|
| Property | Type | Required | Description |
|
|
369
|
-
|
|
226
|
+
| -------- | ---- | -------- | ----------- |
|
|
227
|
+
|
|
370
228
|
|
|
371
229
|
| `name` | string | No | Name of the storecheck template |
|
|
372
230
|
|
|
@@ -388,35 +246,14 @@ Body for updating a storecheck template
|
|
|
388
246
|
|
|
389
247
|
| `integration_meta` | object | No | Integration metadata |
|
|
390
248
|
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
249
|
### StorecheckTemplateUpdateResult
|
|
397
250
|
|
|
398
|
-
|
|
399
251
|
Result of updating a storecheck template
|
|
400
252
|
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
253
|
### StorecheckTemplateRemoveResult
|
|
408
254
|
|
|
409
|
-
|
|
410
255
|
Result of removing a storecheck template
|
|
411
256
|
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
257
|
## TypeScript Usage
|
|
421
258
|
|
|
422
|
-
See [storecheck-template-examples.md](./storecheck-template-examples.md) for detailed TypeScript usage examples.
|
|
259
|
+
See [storecheck-template-examples.md](./storecheck-template-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 subcategories
|
|
26
24
|
|
|
27
|
-
|
|
28
|
-
|
|
29
25
|
```typescript
|
|
30
|
-
|
|
31
26
|
// GET /product/sub-categories
|
|
32
27
|
|
|
33
28
|
const params = {
|
|
34
|
-
|
|
35
29
|
params: null, // Query parameters for filtering subcategories
|
|
36
|
-
|
|
37
30
|
};
|
|
38
31
|
|
|
39
|
-
const result = await fetch(
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
32
|
+
const result = await fetch(
|
|
33
|
+
`${baseURL}/product/sub-categories?${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,16 +55,11 @@ console.log(data);
|
|
|
62
55
|
}
|
|
63
56
|
```
|
|
64
57
|
|
|
65
|
-
|
|
66
58
|
---
|
|
67
59
|
|
|
68
|
-
|
|
69
60
|
### Create a subcategory
|
|
70
61
|
|
|
71
|
-
|
|
72
|
-
|
|
73
62
|
```typescript
|
|
74
|
-
|
|
75
63
|
// POST /product/sub-categories
|
|
76
64
|
|
|
77
65
|
const requestBody = {
|
|
@@ -80,61 +68,48 @@ const requestBody = {
|
|
|
80
68
|
};
|
|
81
69
|
|
|
82
70
|
const result = await fetch(`${baseURL}/product/sub-categories`, {
|
|
83
|
-
method:
|
|
71
|
+
method: "POST",
|
|
84
72
|
headers: {
|
|
85
|
-
|
|
86
|
-
|
|
73
|
+
Authorization: `Bearer ${apiKey}`,
|
|
74
|
+
"Content-Type": "application/json",
|
|
87
75
|
},
|
|
88
|
-
body: JSON.stringify(requestBody)
|
|
76
|
+
body: JSON.stringify(requestBody),
|
|
89
77
|
});
|
|
90
78
|
|
|
91
79
|
const data = await result.json();
|
|
92
80
|
console.log(data);
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
81
|
```
|
|
97
82
|
|
|
98
|
-
|
|
99
|
-
|
|
100
83
|
---
|
|
101
84
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
85
|
### Get a subcategory by ID
|
|
106
86
|
|
|
107
|
-
|
|
108
|
-
|
|
109
87
|
```typescript
|
|
110
|
-
|
|
111
88
|
// GET /product/sub-categories/{id}
|
|
112
89
|
|
|
113
90
|
const params = {
|
|
114
|
-
|
|
115
|
-
id: 'example-value', // No description
|
|
91
|
+
id: "example-value", // No description
|
|
116
92
|
|
|
117
93
|
params: null, // No description
|
|
118
|
-
|
|
119
94
|
};
|
|
120
95
|
|
|
121
|
-
const result = await fetch(
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
96
|
+
const result = await fetch(
|
|
97
|
+
`${baseURL}/product/sub-categories/{id}?${new URLSearchParams(params)}`,
|
|
98
|
+
{
|
|
99
|
+
method: "GET",
|
|
100
|
+
headers: {
|
|
101
|
+
Authorization: `Bearer ${apiKey}`,
|
|
102
|
+
"Content-Type": "application/json",
|
|
103
|
+
},
|
|
126
104
|
}
|
|
127
|
-
|
|
105
|
+
);
|
|
128
106
|
|
|
129
107
|
const data = await result.json();
|
|
130
108
|
console.log(data);
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
109
|
```
|
|
135
110
|
|
|
136
|
-
|
|
137
111
|
**Expected Response:**
|
|
112
|
+
|
|
138
113
|
```json
|
|
139
114
|
{
|
|
140
115
|
"success": true,
|
|
@@ -144,20 +119,16 @@ console.log(data);
|
|
|
144
119
|
}
|
|
145
120
|
```
|
|
146
121
|
|
|
147
|
-
|
|
148
122
|
---
|
|
149
123
|
|
|
150
|
-
|
|
151
124
|
### Update a subcategory
|
|
152
125
|
|
|
153
|
-
|
|
154
|
-
|
|
155
126
|
```typescript
|
|
156
127
|
|
|
157
128
|
```
|
|
158
129
|
|
|
159
|
-
|
|
160
130
|
**Expected Response:**
|
|
131
|
+
|
|
161
132
|
```json
|
|
162
133
|
{
|
|
163
134
|
"success": true,
|
|
@@ -167,37 +138,30 @@ console.log(data);
|
|
|
167
138
|
}
|
|
168
139
|
```
|
|
169
140
|
|
|
170
|
-
|
|
171
141
|
---
|
|
172
142
|
|
|
173
|
-
|
|
174
143
|
### Remove a subcategory
|
|
175
144
|
|
|
176
|
-
|
|
177
|
-
|
|
178
145
|
```typescript
|
|
179
|
-
|
|
180
146
|
// DELETE /product/sub-categories/{id}
|
|
181
147
|
|
|
182
|
-
const id =
|
|
183
|
-
const deletePath =
|
|
148
|
+
const id = "your-resource-id";
|
|
149
|
+
const deletePath = "/product/sub-categories/{id}".replace("{id}", id);
|
|
184
150
|
|
|
185
151
|
const result = await fetch(`${baseURL}${deletePath}`, {
|
|
186
|
-
method:
|
|
152
|
+
method: "DELETE",
|
|
187
153
|
headers: {
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
}
|
|
154
|
+
Authorization: `Bearer ${apiKey}`,
|
|
155
|
+
"Content-Type": "application/json",
|
|
156
|
+
},
|
|
191
157
|
});
|
|
192
158
|
|
|
193
159
|
const data = await result.json();
|
|
194
160
|
console.log(data);
|
|
195
|
-
|
|
196
|
-
|
|
197
161
|
```
|
|
198
162
|
|
|
199
|
-
|
|
200
163
|
**Expected Response:**
|
|
164
|
+
|
|
201
165
|
```json
|
|
202
166
|
{
|
|
203
167
|
"success": true,
|
|
@@ -207,27 +171,21 @@ console.log(data);
|
|
|
207
171
|
}
|
|
208
172
|
```
|
|
209
173
|
|
|
210
|
-
|
|
211
174
|
---
|
|
212
175
|
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
176
|
## Using with Repzo SDK Service Types
|
|
217
177
|
|
|
218
178
|
The Repzo SDK provides TypeScript interfaces for type safety:
|
|
219
179
|
|
|
220
180
|
```typescript
|
|
221
|
-
import { Service } from
|
|
181
|
+
import { Service } from "repzo";
|
|
222
182
|
|
|
223
183
|
// Example using SDK types
|
|
224
184
|
|
|
225
|
-
|
|
226
185
|
async function example() {
|
|
227
186
|
// Use the Service.Subcategory types for better type safety
|
|
228
187
|
// This provides intellisense and compile-time type checking
|
|
229
188
|
}
|
|
230
|
-
|
|
231
189
|
```
|
|
232
190
|
|
|
233
191
|
## Error Handling
|
|
@@ -235,11 +193,11 @@ async function example() {
|
|
|
235
193
|
```typescript
|
|
236
194
|
try {
|
|
237
195
|
const result = await fetch(`${baseURL}/endpoint`, {
|
|
238
|
-
method:
|
|
196
|
+
method: "GET",
|
|
239
197
|
headers: {
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
}
|
|
198
|
+
Authorization: `Bearer ${apiKey}`,
|
|
199
|
+
"Content-Type": "application/json",
|
|
200
|
+
},
|
|
243
201
|
});
|
|
244
202
|
|
|
245
203
|
if (!result.ok) {
|
|
@@ -247,14 +205,14 @@ try {
|
|
|
247
205
|
}
|
|
248
206
|
|
|
249
207
|
const data = await result.json();
|
|
250
|
-
|
|
208
|
+
|
|
251
209
|
if (!data.success) {
|
|
252
|
-
throw new Error(data.error ||
|
|
210
|
+
throw new Error(data.error || "API request failed");
|
|
253
211
|
}
|
|
254
|
-
|
|
212
|
+
|
|
255
213
|
return data.data;
|
|
256
214
|
} catch (error) {
|
|
257
|
-
console.error(
|
|
215
|
+
console.error("API request failed:", error);
|
|
258
216
|
throw error;
|
|
259
217
|
}
|
|
260
218
|
```
|
|
@@ -270,18 +228,21 @@ const params = {
|
|
|
270
228
|
// other filters...
|
|
271
229
|
};
|
|
272
230
|
|
|
273
|
-
const result = await fetch(
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
231
|
+
const result = await fetch(
|
|
232
|
+
`${baseURL}/endpoint?${new URLSearchParams(params)}`,
|
|
233
|
+
{
|
|
234
|
+
method: "GET",
|
|
235
|
+
headers: {
|
|
236
|
+
Authorization: `Bearer ${apiKey}`,
|
|
237
|
+
"Content-Type": "application/json",
|
|
238
|
+
},
|
|
278
239
|
}
|
|
279
|
-
|
|
240
|
+
);
|
|
280
241
|
|
|
281
242
|
const data = await result.json();
|
|
282
243
|
|
|
283
244
|
// Access pagination info
|
|
284
|
-
console.log(
|
|
285
|
-
console.log(
|
|
286
|
-
console.log(
|
|
287
|
-
```
|
|
245
|
+
console.log("Total items:", data.paging.total);
|
|
246
|
+
console.log("Current page:", data.paging.page);
|
|
247
|
+
console.log("Total pages:", data.paging.pages);
|
|
248
|
+
```
|