repzo 1.0.141 → 1.0.142
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 +2 -3
- package/src/types/index.ts +14 -1
|
@@ -6,54 +6,37 @@ API for managing feedback options and templates
|
|
|
6
6
|
|
|
7
7
|
## Overview
|
|
8
8
|
|
|
9
|
-
|
|
10
9
|
### Base URLs
|
|
11
10
|
|
|
12
11
|
- **Production server**: `https://api.repzo.me/v1`
|
|
13
12
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
13
|
### API Categories
|
|
18
14
|
|
|
19
15
|
- **Feedback Options**: Feedback options management operations
|
|
20
16
|
|
|
21
|
-
|
|
22
|
-
|
|
23
17
|
## Authentication
|
|
24
18
|
|
|
25
|
-
|
|
26
19
|
This API uses the following authentication methods:
|
|
27
20
|
|
|
28
|
-
|
|
29
21
|
- **ApiKeyAuth**
|
|
30
22
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
23
|
## Endpoints
|
|
35
24
|
|
|
36
|
-
|
|
37
25
|
### `/feedback-options`
|
|
38
26
|
|
|
39
|
-
|
|
40
27
|
#### GET /feedback-options
|
|
41
28
|
|
|
42
29
|
**Summary:** Get all feedback options
|
|
43
30
|
|
|
44
|
-
|
|
45
31
|
**Description:** Retrieve a list of all feedback options with optional filtering and pagination
|
|
46
32
|
|
|
47
|
-
|
|
48
|
-
|
|
49
33
|
**Tags:** Feedback Options
|
|
50
34
|
|
|
51
|
-
|
|
52
|
-
|
|
53
35
|
##### Parameters
|
|
54
36
|
|
|
55
37
|
| Name | Location | Type | Required | Description |
|
|
56
|
-
|
|
38
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
39
|
+
|
|
57
40
|
|
|
58
41
|
| `page` | query | integer | No | Page number for pagination |
|
|
59
42
|
|
|
@@ -71,477 +54,245 @@ This API uses the following authentication methods:
|
|
|
71
54
|
|
|
72
55
|
| `_id` | query | array | No | Filter by ID |
|
|
73
56
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
57
|
##### Responses
|
|
79
58
|
|
|
80
|
-
|
|
81
59
|
**200** - Successful response
|
|
82
60
|
|
|
83
|
-
|
|
84
|
-
|
|
85
61
|
Content-Type: `application/json`
|
|
86
62
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
63
|
**400** - No description
|
|
91
64
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
65
|
**401** - No description
|
|
96
66
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
67
|
**403** - No description
|
|
101
68
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
69
|
**500** - No description
|
|
106
70
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
71
|
---
|
|
112
72
|
|
|
113
|
-
|
|
114
73
|
#### POST /feedback-options
|
|
115
74
|
|
|
116
75
|
**Summary:** Create new feedback options
|
|
117
76
|
|
|
118
|
-
|
|
119
77
|
**Description:** Create a new feedback options template
|
|
120
78
|
|
|
121
|
-
|
|
122
|
-
|
|
123
79
|
**Tags:** Feedback Options
|
|
124
80
|
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
81
|
##### Request Body
|
|
130
82
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
83
|
**Content Types:**
|
|
135
84
|
|
|
136
85
|
- `application/json`
|
|
137
86
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
87
|
##### Responses
|
|
142
88
|
|
|
143
|
-
|
|
144
89
|
**201** - Feedback options created successfully
|
|
145
90
|
|
|
146
|
-
|
|
147
|
-
|
|
148
91
|
Content-Type: `application/json`
|
|
149
92
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
93
|
**400** - No description
|
|
154
94
|
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
95
|
**401** - No description
|
|
159
96
|
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
97
|
**403** - No description
|
|
164
98
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
99
|
**422** - No description
|
|
169
100
|
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
101
|
**500** - No description
|
|
174
102
|
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
103
|
---
|
|
180
104
|
|
|
181
|
-
|
|
182
|
-
|
|
183
105
|
### `/feedback-options/{id}`
|
|
184
106
|
|
|
185
|
-
|
|
186
107
|
#### GET /feedback-options/{id}
|
|
187
108
|
|
|
188
109
|
**Summary:** Get feedback options by ID
|
|
189
110
|
|
|
190
|
-
|
|
191
111
|
**Description:** Retrieve a specific feedback options template by its ID
|
|
192
112
|
|
|
193
|
-
|
|
194
|
-
|
|
195
113
|
**Tags:** Feedback Options
|
|
196
114
|
|
|
197
|
-
|
|
198
|
-
|
|
199
115
|
##### Parameters
|
|
200
116
|
|
|
201
117
|
| Name | Location | Type | Required | Description |
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
| `id` | path | string | Yes | Feedback options ID |
|
|
205
|
-
|
|
206
|
-
|
|
118
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
207
119
|
|
|
208
120
|
|
|
121
|
+
| `id` | path | string | Yes | Feedback options ID |
|
|
209
122
|
|
|
210
123
|
##### Responses
|
|
211
124
|
|
|
212
|
-
|
|
213
125
|
**200** - Successful response
|
|
214
126
|
|
|
215
|
-
|
|
216
|
-
|
|
217
127
|
Content-Type: `application/json`
|
|
218
128
|
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
129
|
**400** - No description
|
|
223
130
|
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
131
|
**401** - No description
|
|
228
132
|
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
133
|
**403** - No description
|
|
233
134
|
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
135
|
**404** - No description
|
|
238
136
|
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
137
|
**500** - No description
|
|
243
138
|
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
139
|
---
|
|
249
140
|
|
|
250
|
-
|
|
251
141
|
#### PATCH /feedback-options/{id}
|
|
252
142
|
|
|
253
143
|
**Summary:** Update feedback options
|
|
254
144
|
|
|
255
|
-
|
|
256
145
|
**Description:** Update an existing feedback options template
|
|
257
146
|
|
|
258
|
-
|
|
259
|
-
|
|
260
147
|
**Tags:** Feedback Options
|
|
261
148
|
|
|
262
|
-
|
|
263
|
-
|
|
264
149
|
##### Parameters
|
|
265
150
|
|
|
266
151
|
| Name | Location | Type | Required | Description |
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
| `id` | path | string | Yes | Feedback options ID |
|
|
270
|
-
|
|
152
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
271
153
|
|
|
272
154
|
|
|
155
|
+
| `id` | path | string | Yes | Feedback options ID |
|
|
273
156
|
|
|
274
157
|
##### Request Body
|
|
275
158
|
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
159
|
**Content Types:**
|
|
280
160
|
|
|
281
161
|
- `application/json`
|
|
282
162
|
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
163
|
##### Responses
|
|
287
164
|
|
|
288
|
-
|
|
289
165
|
**200** - Feedback options updated successfully
|
|
290
166
|
|
|
291
|
-
|
|
292
|
-
|
|
293
167
|
Content-Type: `application/json`
|
|
294
168
|
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
169
|
**400** - No description
|
|
299
170
|
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
171
|
**401** - No description
|
|
304
172
|
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
173
|
**403** - No description
|
|
309
174
|
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
175
|
**404** - No description
|
|
314
176
|
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
177
|
**422** - No description
|
|
319
178
|
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
179
|
**500** - No description
|
|
324
180
|
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
181
|
---
|
|
330
182
|
|
|
331
|
-
|
|
332
183
|
#### DELETE /feedback-options/{id}
|
|
333
184
|
|
|
334
185
|
**Summary:** Delete feedback options
|
|
335
186
|
|
|
336
|
-
|
|
337
187
|
**Description:** Delete a feedback options template by ID
|
|
338
188
|
|
|
339
|
-
|
|
340
|
-
|
|
341
189
|
**Tags:** Feedback Options
|
|
342
190
|
|
|
343
|
-
|
|
344
|
-
|
|
345
191
|
##### Parameters
|
|
346
192
|
|
|
347
193
|
| Name | Location | Type | Required | Description |
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
| `id` | path | string | Yes | Feedback options ID |
|
|
351
|
-
|
|
352
|
-
|
|
194
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
353
195
|
|
|
354
196
|
|
|
197
|
+
| `id` | path | string | Yes | Feedback options ID |
|
|
355
198
|
|
|
356
199
|
##### Responses
|
|
357
200
|
|
|
358
|
-
|
|
359
201
|
**200** - Feedback options deleted successfully
|
|
360
202
|
|
|
361
|
-
|
|
362
|
-
|
|
363
203
|
Content-Type: `application/json`
|
|
364
204
|
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
205
|
**400** - No description
|
|
369
206
|
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
207
|
**401** - No description
|
|
374
208
|
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
209
|
**403** - No description
|
|
379
210
|
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
211
|
**404** - No description
|
|
384
212
|
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
213
|
**500** - No description
|
|
389
214
|
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
215
|
---
|
|
395
216
|
|
|
396
|
-
|
|
397
|
-
|
|
398
217
|
### `/feedback-options/{id}/preview`
|
|
399
218
|
|
|
400
|
-
|
|
401
219
|
#### GET /feedback-options/{id}/preview
|
|
402
220
|
|
|
403
221
|
**Summary:** Preview feedback template
|
|
404
222
|
|
|
405
|
-
|
|
406
223
|
**Description:** Get a preview of how the feedback template will appear
|
|
407
224
|
|
|
408
|
-
|
|
409
|
-
|
|
410
225
|
**Tags:** Feedback Options
|
|
411
226
|
|
|
412
|
-
|
|
413
|
-
|
|
414
227
|
##### Parameters
|
|
415
228
|
|
|
416
229
|
| Name | Location | Type | Required | Description |
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
| `id` | path | string | Yes | Feedback options ID |
|
|
420
|
-
|
|
421
|
-
|
|
230
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
422
231
|
|
|
423
232
|
|
|
233
|
+
| `id` | path | string | Yes | Feedback options ID |
|
|
424
234
|
|
|
425
235
|
##### Responses
|
|
426
236
|
|
|
427
|
-
|
|
428
237
|
**200** - Template preview retrieved successfully
|
|
429
238
|
|
|
430
|
-
|
|
431
|
-
|
|
432
239
|
Content-Type: `application/json`
|
|
433
240
|
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
241
|
**400** - No description
|
|
438
242
|
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
243
|
**401** - No description
|
|
443
244
|
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
245
|
**403** - No description
|
|
448
246
|
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
247
|
**404** - No description
|
|
453
248
|
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
249
|
**500** - No description
|
|
458
250
|
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
251
|
---
|
|
464
252
|
|
|
465
|
-
|
|
466
|
-
|
|
467
253
|
### `/feedback-options/templates`
|
|
468
254
|
|
|
469
|
-
|
|
470
255
|
#### GET /feedback-options/templates
|
|
471
256
|
|
|
472
257
|
**Summary:** Get predefined templates
|
|
473
258
|
|
|
474
|
-
|
|
475
259
|
**Description:** Get a list of predefined feedback templates
|
|
476
260
|
|
|
477
|
-
|
|
478
|
-
|
|
479
261
|
**Tags:** Feedback Options
|
|
480
262
|
|
|
481
|
-
|
|
482
|
-
|
|
483
263
|
##### Parameters
|
|
484
264
|
|
|
485
265
|
| Name | Location | Type | Required | Description |
|
|
486
|
-
|
|
266
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
267
|
+
|
|
487
268
|
|
|
488
269
|
| `category` | query | string | No | Filter by category |
|
|
489
270
|
|
|
490
271
|
| `template_type` | query | string | No | Filter by template type |
|
|
491
272
|
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
273
|
##### Responses
|
|
497
274
|
|
|
498
|
-
|
|
499
275
|
**200** - Predefined templates retrieved successfully
|
|
500
276
|
|
|
501
|
-
|
|
502
|
-
|
|
503
277
|
Content-Type: `application/json`
|
|
504
278
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
279
|
**400** - No description
|
|
509
280
|
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
281
|
**401** - No description
|
|
514
282
|
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
283
|
**403** - No description
|
|
519
284
|
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
285
|
**500** - No description
|
|
524
286
|
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
287
|
---
|
|
530
288
|
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
289
|
## Data Models
|
|
535
290
|
|
|
536
|
-
|
|
537
|
-
|
|
538
291
|
### FeedbackOptions
|
|
539
292
|
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
293
|
| Property | Type | Required | Description |
|
|
544
|
-
|
|
294
|
+
| -------- | ---- | -------- | ----------- |
|
|
295
|
+
|
|
545
296
|
|
|
546
297
|
| `_id` | string | No | Unique identifier |
|
|
547
298
|
|
|
@@ -575,18 +326,11 @@ Content-Type: `application/json`
|
|
|
575
326
|
|
|
576
327
|
| `__v` | integer | No | Document version |
|
|
577
328
|
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
329
|
### FeedbackQuestion
|
|
584
330
|
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
331
|
| Property | Type | Required | Description |
|
|
589
|
-
|
|
332
|
+
| -------- | ---- | -------- | ----------- |
|
|
333
|
+
|
|
590
334
|
|
|
591
335
|
| `question_id` | string | No | Unique question identifier |
|
|
592
336
|
|
|
@@ -604,18 +348,11 @@ Content-Type: `application/json`
|
|
|
604
348
|
|
|
605
349
|
| `conditional_logic` | object | No | No description |
|
|
606
350
|
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
351
|
### CreateFeedbackOptionsRequest
|
|
613
352
|
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
353
|
| Property | Type | Required | Description |
|
|
618
|
-
|
|
354
|
+
| -------- | ---- | -------- | ----------- |
|
|
355
|
+
|
|
619
356
|
|
|
620
357
|
| `name` | string | Yes | Template name |
|
|
621
358
|
|
|
@@ -637,18 +374,11 @@ Content-Type: `application/json`
|
|
|
637
374
|
|
|
638
375
|
| `company_namespace` | array | No | Company namespace |
|
|
639
376
|
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
377
|
### UpdateFeedbackOptionsRequest
|
|
646
378
|
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
379
|
| Property | Type | Required | Description |
|
|
651
|
-
|
|
380
|
+
| -------- | ---- | -------- | ----------- |
|
|
381
|
+
|
|
652
382
|
|
|
653
383
|
| `name` | string | No | Template name |
|
|
654
384
|
|
|
@@ -668,18 +398,11 @@ Content-Type: `application/json`
|
|
|
668
398
|
|
|
669
399
|
| `company_namespace` | array | No | Company namespace |
|
|
670
400
|
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
401
|
### PagingInfo
|
|
677
402
|
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
403
|
| Property | Type | Required | Description |
|
|
682
|
-
|
|
404
|
+
| -------- | ---- | -------- | ----------- |
|
|
405
|
+
|
|
683
406
|
|
|
684
407
|
| `total` | integer | No | Total number of items |
|
|
685
408
|
|
|
@@ -689,13 +412,6 @@ Content-Type: `application/json`
|
|
|
689
412
|
|
|
690
413
|
| `pages` | integer | No | Total number of pages |
|
|
691
414
|
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
415
|
## TypeScript Usage
|
|
700
416
|
|
|
701
|
-
See [feedback-options-examples.md](./feedback-options-examples.md) for detailed TypeScript usage examples.
|
|
417
|
+
See [feedback-options-examples.md](./feedback-options-examples.md) for detailed TypeScript usage examples.
|