repzo 1.0.143 → 1.0.144
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/api/activity-ai-sales-order-examples.md +3 -3
- package/docs/api/activity-ai-sales-order.md +0 -7
- package/docs/api/activity-feedback-examples.md +4 -4
- package/docs/api/activity-feedback-v2-examples.md +5 -5
- package/docs/api/activity-feedback-v2.md +0 -9
- package/docs/api/activity-feedback.md +0 -9
- package/docs/api/activity-storecheck-examples.md +3 -3
- package/docs/api/activity-storecheck.md +0 -6
- package/docs/api/adjust-account-examples.md +3 -3
- package/docs/api/adjust-account.md +0 -5
- package/docs/api/adjust-inventory-examples.md +3 -3
- package/docs/api/adjust-inventory.md +0 -7
- package/docs/api/approval-request-examples.md +3 -3
- package/docs/api/approval-request.md +0 -12
- package/docs/api/approvals-examples.md +3 -3
- package/docs/api/approvals.md +0 -12
- package/docs/api/asset-examples.md +2 -2
- package/docs/api/asset-part-examples.md +3 -3
- package/docs/api/asset-part-receival-examples.md +3 -3
- package/docs/api/asset-part-receival.md +0 -6
- package/docs/api/asset-part-transfer-examples.md +3 -3
- package/docs/api/asset-part-transfer.md +0 -7
- package/docs/api/asset-part-type-examples.md +3 -3
- package/docs/api/asset-part-type.md +0 -6
- package/docs/api/asset-part-unit-examples.md +3 -3
- package/docs/api/asset-part-unit.md +0 -6
- package/docs/api/asset-part.md +0 -6
- package/docs/api/asset-type-examples.md +3 -3
- package/docs/api/asset-type.md +0 -12
- package/docs/api/asset-unit-examples.md +3 -3
- package/docs/api/asset-unit.md +0 -9
- package/docs/api/asset.md +0 -12
- package/docs/api/banks-examples.md +2 -2
- package/docs/api/banks.md +0 -12
- package/docs/api/bankslists-examples.md +3 -3
- package/docs/api/bankslists.md +0 -12
- package/docs/api/brand-examples.md +3 -3
- package/docs/api/brand.md +0 -8
- package/docs/api/category-examples.md +3 -3
- package/docs/api/category.md +0 -8
- package/docs/api/checks-examples.md +2 -2
- package/docs/api/checks.md +0 -5
- package/docs/api/client-channel-examples.md +3 -3
- package/docs/api/client-channel.md +0 -8
- package/docs/api/client-contact-examples.md +3 -3
- package/docs/api/client-contact.md +0 -11
- package/docs/api/client-examples.md +2 -2
- package/docs/api/client-location-examples.md +3 -3
- package/docs/api/client-location.md +0 -9
- package/docs/api/client.md +0 -8
- package/docs/api/contract-examples.md +3 -3
- package/docs/api/contract-installment-examples.md +4 -4
- package/docs/api/contract-installment.md +0 -10
- package/docs/api/contract.md +0 -12
- package/docs/api/custom-list-examples.md +3 -3
- package/docs/api/custom-list-item-examples.md +3 -3
- package/docs/api/custom-list-item.md +0 -12
- package/docs/api/custom-list.md +0 -12
- package/docs/api/custom-status-examples.md +3 -3
- package/docs/api/custom-status.md +0 -12
- package/docs/api/day-examples.md +2 -2
- package/docs/api/day.md +0 -5
- package/docs/api/feedback-options-examples.md +5 -5
- package/docs/api/feedback-options.md +0 -11
- package/docs/api/fullinvoices-examples.md +3 -3
- package/docs/api/fullinvoices.md +0 -10
- package/docs/api/integration-action-log-examples.md +3 -3
- package/docs/api/integration-action-log.md +0 -6
- package/docs/api/integration-app-examples.md +3 -3
- package/docs/api/integration-app.md +0 -7
- package/docs/api/integration-command-log-examples.md +3 -3
- package/docs/api/integration-command-log.md +0 -6
- package/docs/api/inventory-adjustment-reason-examples.md +3 -3
- package/docs/api/inventory-adjustment-reason.md +0 -12
- package/docs/api/inventory-examples.md +2 -2
- package/docs/api/inventory.md +0 -3
- package/docs/api/mail-unsubscribe-examples.md +3 -3
- package/docs/api/mail-unsubscribe.md +0 -6
- package/docs/api/measureunit-examples.md +3 -3
- package/docs/api/measureunit-family-examples.md +3 -3
- package/docs/api/measureunit-family.md +0 -8
- package/docs/api/measureunit.md +0 -9
- package/docs/api/media-examples.md +2 -2
- package/docs/api/media-storage-examples.md +3 -3
- package/docs/api/media-storage.md +0 -8
- package/docs/api/media.md +0 -8
- package/docs/api/msl-examples.md +2 -2
- package/docs/api/msl-products-examples.md +3 -3
- package/docs/api/msl-products.md +0 -12
- package/docs/api/msl.md +0 -12
- package/docs/api/ocr-invoice-job-examples.md +4 -4
- package/docs/api/ocr-invoice-job-group-examples.md +4 -4
- package/docs/api/ocr-invoice-job-group.md +0 -7
- package/docs/api/ocr-invoice-job-page-examples.md +3 -3
- package/docs/api/ocr-invoice-job-page.md +0 -7
- package/docs/api/ocr-invoice-job-template-examples.md +3 -3
- package/docs/api/ocr-invoice-job-template.md +0 -6
- package/docs/api/ocr-invoice-job.md +0 -9
- package/docs/api/patch-action-examples.md +3 -3
- package/docs/api/patch-action.md +0 -7
- package/docs/api/payment-terms-examples.md +3 -3
- package/docs/api/payment-terms.md +0 -13
- package/docs/api/payments-examples.md +3 -3
- package/docs/api/payments.md +0 -10
- package/docs/api/pricelist-examples.md +3 -3
- package/docs/api/pricelist-item-examples.md +3 -3
- package/docs/api/pricelist-item.md +0 -11
- package/docs/api/pricelist.md +0 -8
- package/docs/api/product-examples.md +3 -3
- package/docs/api/product-group-examples.md +3 -3
- package/docs/api/product-group.md +0 -8
- package/docs/api/product-modifiers-group-examples.md +3 -3
- package/docs/api/product-modifiers-group.md +0 -9
- package/docs/api/product.md +0 -9
- package/docs/api/proforma-examples.md +3 -3
- package/docs/api/proforma.md +0 -10
- package/docs/api/quick-convert-to-pdf-examples.md +1 -1
- package/docs/api/quick-convert-to-pdf.md +0 -2
- package/docs/api/receiving-material-examples.md +3 -3
- package/docs/api/receiving-material.md +0 -7
- package/docs/api/refund-examples.md +2 -2
- package/docs/api/refund.md +0 -7
- package/docs/api/rep-balance-summary-examples.md +2 -2
- package/docs/api/rep-balance-summary.md +0 -2
- package/docs/api/rep-examples.md +2 -2
- package/docs/api/rep.md +0 -8
- package/docs/api/return-asset-part-unit-examples.md +3 -3
- package/docs/api/return-asset-part-unit.md +0 -6
- package/docs/api/return-reason-examples.md +3 -3
- package/docs/api/return-reason.md +0 -8
- package/docs/api/route-examples.md +2 -2
- package/docs/api/route.md +0 -8
- package/docs/api/safe-invoice-serial-counter-examples.md +3 -3
- package/docs/api/safe-invoice-serial-counter.md +0 -8
- package/docs/api/settings-examples.md +3 -3
- package/docs/api/settings.md +0 -8
- package/docs/api/settlement-examples.md +3 -3
- package/docs/api/settlement.md +0 -5
- package/docs/api/speciality-examples.md +3 -3
- package/docs/api/speciality.md +0 -8
- package/docs/api/store-asset-part-unit-examples.md +3 -3
- package/docs/api/store-asset-part-unit.md +0 -6
- package/docs/api/storecheck-template-examples.md +3 -3
- package/docs/api/storecheck-template.md +0 -8
- package/docs/api/subcategory-examples.md +3 -3
- package/docs/api/subcategory.md +0 -8
- package/docs/api/supplier-examples.md +3 -3
- package/docs/api/supplier.md +0 -12
- package/docs/api/svix-integration-examples.md +3 -3
- package/docs/api/svix-integration.md +0 -6
- package/docs/api/tag-examples.md +2 -2
- package/docs/api/tag.md +0 -8
- package/docs/api/tax-examples.md +2 -2
- package/docs/api/tax.md +0 -8
- package/docs/api/team-examples.md +2 -2
- package/docs/api/team.md +0 -8
- package/docs/api/transfer-examples.md +3 -3
- package/docs/api/transfer.md +0 -7
- package/docs/api/update-integration-meta-examples.md +3 -3
- package/docs/api/update-integration-meta.md +0 -7
- package/docs/api/variant-examples.md +3 -3
- package/docs/api/variant.md +0 -9
- package/docs/api/visit-examples.md +2 -2
- package/docs/api/visit.md +0 -10
- package/docs/api/warehouse-examples.md +3 -3
- package/docs/api/warehouse.md +0 -8
- package/docs/api/workorder-category-examples.md +3 -3
- package/docs/api/workorder-category.md +0 -9
- package/docs/api/workorder-examples.md +3 -3
- package/docs/api/workorder-portal-examples.md +3 -3
- package/docs/api/workorder-portal-link-examples.md +3 -3
- package/docs/api/workorder-portal-link.md +0 -11
- package/docs/api/workorder-portal.md +0 -9
- package/docs/api/workorder-request-examples.md +3 -3
- package/docs/api/workorder-request.md +0 -12
- package/docs/api/workorder.md +0 -12
- package/lib/index.d.ts +388 -387
- package/lib/index.js +366 -365
- package/lib/types/index.d.ts +14663 -13407
- package/package.json +6 -5
- package/src/types/index.ts +22 -18
package/docs/api/product.md
CHANGED
|
@@ -27,7 +27,6 @@ No authentication required.
|
|
|
27
27
|
| Name | Location | Type | Required | Description |
|
|
28
28
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
29
29
|
|
|
30
|
-
|
|
31
30
|
| `params` | query | object | No | Query parameters for filtering products |
|
|
32
31
|
|
|
33
32
|
##### Responses
|
|
@@ -67,7 +66,6 @@ Content-Type: `application/json`
|
|
|
67
66
|
| Name | Location | Type | Required | Description |
|
|
68
67
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
69
68
|
|
|
70
|
-
|
|
71
69
|
| `id` | path | string | Yes | No description |
|
|
72
70
|
|
|
73
71
|
##### Responses
|
|
@@ -87,7 +85,6 @@ Content-Type: `application/json`
|
|
|
87
85
|
| Name | Location | Type | Required | Description |
|
|
88
86
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
89
87
|
|
|
90
|
-
|
|
91
88
|
| `id` | path | string | Yes | No description |
|
|
92
89
|
|
|
93
90
|
##### Request Body
|
|
@@ -113,7 +110,6 @@ Content-Type: `application/json`
|
|
|
113
110
|
| Name | Location | Type | Required | Description |
|
|
114
111
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
115
112
|
|
|
116
|
-
|
|
117
113
|
| `id` | path | string | Yes | No description |
|
|
118
114
|
|
|
119
115
|
##### Responses
|
|
@@ -133,7 +129,6 @@ Result of finding products
|
|
|
133
129
|
| Property | Type | Required | Description |
|
|
134
130
|
| -------- | ---- | -------- | ----------- |
|
|
135
131
|
|
|
136
|
-
|
|
137
132
|
| `data` | array | No | No description |
|
|
138
133
|
|
|
139
134
|
| `total_result` | number | No | Total number of products |
|
|
@@ -163,7 +158,6 @@ Product schema
|
|
|
163
158
|
| Property | Type | Required | Description |
|
|
164
159
|
| -------- | ---- | -------- | ----------- |
|
|
165
160
|
|
|
166
|
-
|
|
167
161
|
| `_id` | string | No | Unique identifier for the product |
|
|
168
162
|
|
|
169
163
|
| `name` | string | No | Name of the product |
|
|
@@ -237,7 +231,6 @@ Body for creating a product
|
|
|
237
231
|
| Property | Type | Required | Description |
|
|
238
232
|
| -------- | ---- | -------- | ----------- |
|
|
239
233
|
|
|
240
|
-
|
|
241
234
|
| `name` | string | Yes | Name of the product |
|
|
242
235
|
|
|
243
236
|
| `category` | string | Yes | ID of the product category |
|
|
@@ -313,7 +306,6 @@ Body for updating a product
|
|
|
313
306
|
| Property | Type | Required | Description |
|
|
314
307
|
| -------- | ---- | -------- | ----------- |
|
|
315
308
|
|
|
316
|
-
|
|
317
309
|
| `name` | string | No | Name of the product |
|
|
318
310
|
|
|
319
311
|
| `category` | string | No | ID of the product category |
|
|
@@ -397,7 +389,6 @@ Body for creating a variant
|
|
|
397
389
|
| Property | Type | Required | Description |
|
|
398
390
|
| -------- | ---- | -------- | ----------- |
|
|
399
391
|
|
|
400
|
-
|
|
401
392
|
| `name` | string | No | Name of the variant |
|
|
402
393
|
|
|
403
394
|
| `product` | string | No | ID of the product this variant belongs to |
|
|
@@ -37,7 +37,7 @@ const result = await fetch(
|
|
|
37
37
|
Authorization: `Bearer ${apiKey}`,
|
|
38
38
|
"Content-Type": "application/json",
|
|
39
39
|
},
|
|
40
|
-
}
|
|
40
|
+
},
|
|
41
41
|
);
|
|
42
42
|
|
|
43
43
|
const data = await result.json();
|
|
@@ -99,7 +99,7 @@ const result = await fetch(
|
|
|
99
99
|
Authorization: `Bearer ${apiKey}`,
|
|
100
100
|
"Content-Type": "application/json",
|
|
101
101
|
},
|
|
102
|
-
}
|
|
102
|
+
},
|
|
103
103
|
);
|
|
104
104
|
|
|
105
105
|
const data = await result.json();
|
|
@@ -201,7 +201,7 @@ const result = await fetch(
|
|
|
201
201
|
Authorization: `Bearer ${apiKey}`,
|
|
202
202
|
"Content-Type": "application/json",
|
|
203
203
|
},
|
|
204
|
-
}
|
|
204
|
+
},
|
|
205
205
|
);
|
|
206
206
|
|
|
207
207
|
const data = await result.json();
|
package/docs/api/proforma.md
CHANGED
|
@@ -27,7 +27,6 @@ No authentication required.
|
|
|
27
27
|
| Name | Location | Type | Required | Description |
|
|
28
28
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
29
29
|
|
|
30
|
-
|
|
31
30
|
| `params` | query | object | No | Query parameters for filtering proformas |
|
|
32
31
|
|
|
33
32
|
##### Responses
|
|
@@ -67,7 +66,6 @@ Content-Type: `application/json`
|
|
|
67
66
|
| Name | Location | Type | Required | Description |
|
|
68
67
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
69
68
|
|
|
70
|
-
|
|
71
69
|
| `id` | path | string | Yes | No description |
|
|
72
70
|
|
|
73
71
|
##### Responses
|
|
@@ -87,7 +85,6 @@ Content-Type: `application/json`
|
|
|
87
85
|
| Name | Location | Type | Required | Description |
|
|
88
86
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
89
87
|
|
|
90
|
-
|
|
91
88
|
| `id` | path | string | Yes | No description |
|
|
92
89
|
|
|
93
90
|
##### Request Body
|
|
@@ -111,7 +108,6 @@ Content-Type: `application/json`
|
|
|
111
108
|
| Property | Type | Required | Description |
|
|
112
109
|
| -------- | ---- | -------- | ----------- |
|
|
113
110
|
|
|
114
|
-
|
|
115
111
|
| `data` | array | No | No description |
|
|
116
112
|
|
|
117
113
|
| `meta` | object | No | No description |
|
|
@@ -121,7 +117,6 @@ Content-Type: `application/json`
|
|
|
121
117
|
| Property | Type | Required | Description |
|
|
122
118
|
| -------- | ---- | -------- | ----------- |
|
|
123
119
|
|
|
124
|
-
|
|
125
120
|
| `serial` | string | No | No description |
|
|
126
121
|
|
|
127
122
|
| `client` | string | No | No description |
|
|
@@ -143,7 +138,6 @@ Content-Type: `application/json`
|
|
|
143
138
|
| Property | Type | Required | Description |
|
|
144
139
|
| -------- | ---- | -------- | ----------- |
|
|
145
140
|
|
|
146
|
-
|
|
147
141
|
| `data` | object | No | No description |
|
|
148
142
|
|
|
149
143
|
### ProformaGetResult
|
|
@@ -151,7 +145,6 @@ Content-Type: `application/json`
|
|
|
151
145
|
| Property | Type | Required | Description |
|
|
152
146
|
| -------- | ---- | -------- | ----------- |
|
|
153
147
|
|
|
154
|
-
|
|
155
148
|
| `data` | object | No | No description |
|
|
156
149
|
|
|
157
150
|
### ProformaUpdateBody
|
|
@@ -159,7 +152,6 @@ Content-Type: `application/json`
|
|
|
159
152
|
| Property | Type | Required | Description |
|
|
160
153
|
| -------- | ---- | -------- | ----------- |
|
|
161
154
|
|
|
162
|
-
|
|
163
155
|
| `serial` | string | No | No description |
|
|
164
156
|
|
|
165
157
|
| `client` | string | No | No description |
|
|
@@ -181,7 +173,6 @@ Content-Type: `application/json`
|
|
|
181
173
|
| Property | Type | Required | Description |
|
|
182
174
|
| -------- | ---- | -------- | ----------- |
|
|
183
175
|
|
|
184
|
-
|
|
185
176
|
| `data` | object | No | No description |
|
|
186
177
|
|
|
187
178
|
### Proforma
|
|
@@ -189,7 +180,6 @@ Content-Type: `application/json`
|
|
|
189
180
|
| Property | Type | Required | Description |
|
|
190
181
|
| -------- | ---- | -------- | ----------- |
|
|
191
182
|
|
|
192
|
-
|
|
193
183
|
| `_id` | string | No | No description |
|
|
194
184
|
|
|
195
185
|
| `serial` | string | No | No description |
|
|
@@ -45,7 +45,6 @@ Body for converting document to PDF
|
|
|
45
45
|
| Property | Type | Required | Description |
|
|
46
46
|
| -------- | ---- | -------- | ----------- |
|
|
47
47
|
|
|
48
|
-
|
|
49
48
|
| `documentType` | string | Yes | Type of document to convert |
|
|
50
49
|
|
|
51
50
|
| `documentId` | string | Yes | ID of the document to convert |
|
|
@@ -63,7 +62,6 @@ Result of PDF conversion
|
|
|
63
62
|
| Property | Type | Required | Description |
|
|
64
63
|
| -------- | ---- | -------- | ----------- |
|
|
65
64
|
|
|
66
|
-
|
|
67
65
|
| `success` | boolean | No | Whether conversion was successful |
|
|
68
66
|
|
|
69
67
|
| `pdfUrl` | string | No | URL to download the generated PDF |
|
|
@@ -37,7 +37,7 @@ const result = await fetch(
|
|
|
37
37
|
Authorization: `Bearer ${apiKey}`,
|
|
38
38
|
"Content-Type": "application/json",
|
|
39
39
|
},
|
|
40
|
-
}
|
|
40
|
+
},
|
|
41
41
|
);
|
|
42
42
|
|
|
43
43
|
const data = await result.json();
|
|
@@ -99,7 +99,7 @@ const result = await fetch(
|
|
|
99
99
|
Authorization: `Bearer ${apiKey}`,
|
|
100
100
|
"Content-Type": "application/json",
|
|
101
101
|
},
|
|
102
|
-
}
|
|
102
|
+
},
|
|
103
103
|
);
|
|
104
104
|
|
|
105
105
|
const data = await result.json();
|
|
@@ -201,7 +201,7 @@ const result = await fetch(
|
|
|
201
201
|
Authorization: `Bearer ${apiKey}`,
|
|
202
202
|
"Content-Type": "application/json",
|
|
203
203
|
},
|
|
204
|
-
}
|
|
204
|
+
},
|
|
205
205
|
);
|
|
206
206
|
|
|
207
207
|
const data = await result.json();
|
|
@@ -27,7 +27,6 @@ No authentication required.
|
|
|
27
27
|
| Name | Location | Type | Required | Description |
|
|
28
28
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
29
29
|
|
|
30
|
-
|
|
31
30
|
| `params` | query | object | No | Query parameters for filtering receiving materials |
|
|
32
31
|
|
|
33
32
|
##### Responses
|
|
@@ -67,7 +66,6 @@ Content-Type: `application/json`
|
|
|
67
66
|
| Name | Location | Type | Required | Description |
|
|
68
67
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
69
68
|
|
|
70
|
-
|
|
71
69
|
| `id` | path | string | Yes | No description |
|
|
72
70
|
|
|
73
71
|
##### Responses
|
|
@@ -87,7 +85,6 @@ Content-Type: `application/json`
|
|
|
87
85
|
| Name | Location | Type | Required | Description |
|
|
88
86
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
89
87
|
|
|
90
|
-
|
|
91
88
|
| `id` | path | string | Yes | No description |
|
|
92
89
|
|
|
93
90
|
##### Request Body
|
|
@@ -113,7 +110,6 @@ Result of finding receiving materials
|
|
|
113
110
|
| Property | Type | Required | Description |
|
|
114
111
|
| -------- | ---- | -------- | ----------- |
|
|
115
112
|
|
|
116
|
-
|
|
117
113
|
| `data` | array | No | No description |
|
|
118
114
|
|
|
119
115
|
| `total_result` | number | No | Total number of receiving materials |
|
|
@@ -133,7 +129,6 @@ Receiving material schema
|
|
|
133
129
|
| Property | Type | Required | Description |
|
|
134
130
|
| -------- | ---- | -------- | ----------- |
|
|
135
131
|
|
|
136
|
-
|
|
137
132
|
| `_id` | string | No | Unique identifier for the receiving material |
|
|
138
133
|
|
|
139
134
|
| `warehouse` | string | No | Warehouse ID where materials are received |
|
|
@@ -171,7 +166,6 @@ Body for creating a receiving material
|
|
|
171
166
|
| Property | Type | Required | Description |
|
|
172
167
|
| -------- | ---- | -------- | ----------- |
|
|
173
168
|
|
|
174
|
-
|
|
175
169
|
| `warehouse` | string | Yes | Warehouse ID where materials are received |
|
|
176
170
|
|
|
177
171
|
| `supplier` | string | Yes | Supplier ID providing the materials |
|
|
@@ -203,7 +197,6 @@ Body for updating a receiving material
|
|
|
203
197
|
| Property | Type | Required | Description |
|
|
204
198
|
| -------- | ---- | -------- | ----------- |
|
|
205
199
|
|
|
206
|
-
|
|
207
200
|
| `receiptDate` | string | No | Date when materials were received |
|
|
208
201
|
|
|
209
202
|
| `items` | array | No | List of items received |
|
|
@@ -96,7 +96,7 @@ const result = await fetch(
|
|
|
96
96
|
Authorization: `Bearer ${apiKey}`,
|
|
97
97
|
"Content-Type": "application/json",
|
|
98
98
|
},
|
|
99
|
-
}
|
|
99
|
+
},
|
|
100
100
|
);
|
|
101
101
|
|
|
102
102
|
const data = await result.json();
|
|
@@ -198,7 +198,7 @@ const result = await fetch(
|
|
|
198
198
|
Authorization: `Bearer ${apiKey}`,
|
|
199
199
|
"Content-Type": "application/json",
|
|
200
200
|
},
|
|
201
|
-
}
|
|
201
|
+
},
|
|
202
202
|
);
|
|
203
203
|
|
|
204
204
|
const data = await result.json();
|
package/docs/api/refund.md
CHANGED
|
@@ -27,7 +27,6 @@ No authentication required.
|
|
|
27
27
|
| Name | Location | Type | Required | Description |
|
|
28
28
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
29
29
|
|
|
30
|
-
|
|
31
30
|
| `params` | query | object | No | Query parameters for filtering refunds |
|
|
32
31
|
|
|
33
32
|
##### Responses
|
|
@@ -67,7 +66,6 @@ Content-Type: `application/json`
|
|
|
67
66
|
| Name | Location | Type | Required | Description |
|
|
68
67
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
69
68
|
|
|
70
|
-
|
|
71
69
|
| `id` | path | string | Yes | No description |
|
|
72
70
|
|
|
73
71
|
##### Responses
|
|
@@ -87,7 +85,6 @@ Content-Type: `application/json`
|
|
|
87
85
|
| Name | Location | Type | Required | Description |
|
|
88
86
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
89
87
|
|
|
90
|
-
|
|
91
88
|
| `id` | path | string | Yes | No description |
|
|
92
89
|
|
|
93
90
|
##### Request Body
|
|
@@ -113,7 +110,6 @@ Result of finding refunds
|
|
|
113
110
|
| Property | Type | Required | Description |
|
|
114
111
|
| -------- | ---- | -------- | ----------- |
|
|
115
112
|
|
|
116
|
-
|
|
117
113
|
| `data` | array | No | No description |
|
|
118
114
|
|
|
119
115
|
| `total_result` | number | No | Total number of refunds |
|
|
@@ -133,7 +129,6 @@ Refund schema
|
|
|
133
129
|
| Property | Type | Required | Description |
|
|
134
130
|
| -------- | ---- | -------- | ----------- |
|
|
135
131
|
|
|
136
|
-
|
|
137
132
|
| `_id` | string | No | Unique identifier for the refund |
|
|
138
133
|
|
|
139
134
|
| `client` | string | No | Client ID associated with the refund |
|
|
@@ -173,7 +168,6 @@ Body for creating a refund
|
|
|
173
168
|
| Property | Type | Required | Description |
|
|
174
169
|
| -------- | ---- | -------- | ----------- |
|
|
175
170
|
|
|
176
|
-
|
|
177
171
|
| `client` | string | Yes | Client ID associated with the refund |
|
|
178
172
|
|
|
179
173
|
| `rep` | string | No | Representative ID who processed the refund |
|
|
@@ -207,7 +201,6 @@ Body for updating a refund
|
|
|
207
201
|
| Property | Type | Required | Description |
|
|
208
202
|
| -------- | ---- | -------- | ----------- |
|
|
209
203
|
|
|
210
|
-
|
|
211
204
|
| `status` | string | No | Status of the refund |
|
|
212
205
|
|
|
213
206
|
| `refundMethod` | string | No | Method of refund |
|
|
@@ -45,7 +45,7 @@ const result = await fetch(
|
|
|
45
45
|
Authorization: `Bearer ${apiKey}`,
|
|
46
46
|
"Content-Type": "application/json",
|
|
47
47
|
},
|
|
48
|
-
}
|
|
48
|
+
},
|
|
49
49
|
);
|
|
50
50
|
|
|
51
51
|
const data = await result.json();
|
|
@@ -128,7 +128,7 @@ const result = await fetch(
|
|
|
128
128
|
Authorization: `Bearer ${apiKey}`,
|
|
129
129
|
"Content-Type": "application/json",
|
|
130
130
|
},
|
|
131
|
-
}
|
|
131
|
+
},
|
|
132
132
|
);
|
|
133
133
|
|
|
134
134
|
const data = await result.json();
|
|
@@ -27,7 +27,6 @@ No authentication required.
|
|
|
27
27
|
| Name | Location | Type | Required | Description |
|
|
28
28
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
29
29
|
|
|
30
|
-
|
|
31
30
|
| `rep` | query | string | Yes | The rep ID to get balance summary for |
|
|
32
31
|
|
|
33
32
|
| `page` | query | integer | No | Page number for pagination |
|
|
@@ -59,7 +58,6 @@ Content-Type: `application/json`
|
|
|
59
58
|
| Property | Type | Required | Description |
|
|
60
59
|
| -------- | ---- | -------- | ----------- |
|
|
61
60
|
|
|
62
|
-
|
|
63
61
|
| `_id` | string | Yes | Unique identifier for the rep balance summary |
|
|
64
62
|
|
|
65
63
|
| `rep` | string | Yes | Rep ID |
|
package/docs/api/rep-examples.md
CHANGED
|
@@ -96,7 +96,7 @@ const result = await fetch(
|
|
|
96
96
|
Authorization: `Bearer ${apiKey}`,
|
|
97
97
|
"Content-Type": "application/json",
|
|
98
98
|
},
|
|
99
|
-
}
|
|
99
|
+
},
|
|
100
100
|
);
|
|
101
101
|
|
|
102
102
|
const data = await result.json();
|
|
@@ -231,7 +231,7 @@ const result = await fetch(
|
|
|
231
231
|
Authorization: `Bearer ${apiKey}`,
|
|
232
232
|
"Content-Type": "application/json",
|
|
233
233
|
},
|
|
234
|
-
}
|
|
234
|
+
},
|
|
235
235
|
);
|
|
236
236
|
|
|
237
237
|
const data = await result.json();
|
package/docs/api/rep.md
CHANGED
|
@@ -27,7 +27,6 @@ No authentication required.
|
|
|
27
27
|
| Name | Location | Type | Required | Description |
|
|
28
28
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
29
29
|
|
|
30
|
-
|
|
31
30
|
| `params` | query | object | No | Query parameters for filtering reps |
|
|
32
31
|
|
|
33
32
|
##### Responses
|
|
@@ -67,7 +66,6 @@ Content-Type: `application/json`
|
|
|
67
66
|
| Name | Location | Type | Required | Description |
|
|
68
67
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
69
68
|
|
|
70
|
-
|
|
71
69
|
| `id` | path | string | Yes | No description |
|
|
72
70
|
|
|
73
71
|
##### Responses
|
|
@@ -87,7 +85,6 @@ Content-Type: `application/json`
|
|
|
87
85
|
| Name | Location | Type | Required | Description |
|
|
88
86
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
89
87
|
|
|
90
|
-
|
|
91
88
|
| `id` | path | string | Yes | No description |
|
|
92
89
|
|
|
93
90
|
##### Request Body
|
|
@@ -113,7 +110,6 @@ Content-Type: `application/json`
|
|
|
113
110
|
| Name | Location | Type | Required | Description |
|
|
114
111
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
115
112
|
|
|
116
|
-
|
|
117
113
|
| `id` | path | string | Yes | No description |
|
|
118
114
|
|
|
119
115
|
##### Responses
|
|
@@ -133,7 +129,6 @@ Result of finding reps
|
|
|
133
129
|
| Property | Type | Required | Description |
|
|
134
130
|
| -------- | ---- | -------- | ----------- |
|
|
135
131
|
|
|
136
|
-
|
|
137
132
|
| `data` | array | No | No description |
|
|
138
133
|
|
|
139
134
|
| `total_result` | number | No | Total number of reps |
|
|
@@ -163,7 +158,6 @@ Rep schema
|
|
|
163
158
|
| Property | Type | Required | Description |
|
|
164
159
|
| -------- | ---- | -------- | ----------- |
|
|
165
160
|
|
|
166
|
-
|
|
167
161
|
| `_id` | string | No | Unique identifier for the rep |
|
|
168
162
|
|
|
169
163
|
| `name` | string | No | Name of the rep |
|
|
@@ -203,7 +197,6 @@ Body for creating a rep
|
|
|
203
197
|
| Property | Type | Required | Description |
|
|
204
198
|
| -------- | ---- | -------- | ----------- |
|
|
205
199
|
|
|
206
|
-
|
|
207
200
|
| `name` | string | Yes | Name of the rep |
|
|
208
201
|
|
|
209
202
|
| `email` | string | Yes | Email of the rep |
|
|
@@ -243,7 +236,6 @@ Body for updating a rep
|
|
|
243
236
|
| Property | Type | Required | Description |
|
|
244
237
|
| -------- | ---- | -------- | ----------- |
|
|
245
238
|
|
|
246
|
-
|
|
247
239
|
| `name` | string | No | Name of the rep |
|
|
248
240
|
|
|
249
241
|
| `email` | string | No | Email of the rep |
|
|
@@ -49,7 +49,7 @@ const result = await fetch(
|
|
|
49
49
|
Authorization: `Bearer ${apiKey}`,
|
|
50
50
|
"Content-Type": "application/json",
|
|
51
51
|
},
|
|
52
|
-
}
|
|
52
|
+
},
|
|
53
53
|
);
|
|
54
54
|
|
|
55
55
|
const data = await result.json();
|
|
@@ -115,7 +115,7 @@ const result = await fetch(
|
|
|
115
115
|
Authorization: `Bearer ${apiKey}`,
|
|
116
116
|
"Content-Type": "application/json",
|
|
117
117
|
},
|
|
118
|
-
}
|
|
118
|
+
},
|
|
119
119
|
);
|
|
120
120
|
|
|
121
121
|
const data = await result.json();
|
|
@@ -254,7 +254,7 @@ const result = await fetch(
|
|
|
254
254
|
Authorization: `Bearer ${apiKey}`,
|
|
255
255
|
"Content-Type": "application/json",
|
|
256
256
|
},
|
|
257
|
-
}
|
|
257
|
+
},
|
|
258
258
|
);
|
|
259
259
|
|
|
260
260
|
const data = await result.json();
|
|
@@ -39,7 +39,6 @@ This API uses the following authentication methods:
|
|
|
39
39
|
| Name | Location | Type | Required | Description |
|
|
40
40
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
41
41
|
|
|
42
|
-
|
|
43
42
|
| `limit` | query | integer | No | Maximum number of records to return |
|
|
44
43
|
|
|
45
44
|
| `offset` | query | integer | No | Number of records to skip for pagination |
|
|
@@ -109,7 +108,6 @@ Content-Type: `application/json`
|
|
|
109
108
|
| Name | Location | Type | Required | Description |
|
|
110
109
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
111
110
|
|
|
112
|
-
|
|
113
111
|
| `id` | path | string | Yes | Asset part unit return ID |
|
|
114
112
|
|
|
115
113
|
##### Responses
|
|
@@ -139,7 +137,6 @@ Content-Type: `application/json`
|
|
|
139
137
|
| Name | Location | Type | Required | Description |
|
|
140
138
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
141
139
|
|
|
142
|
-
|
|
143
140
|
| `id` | path | string | Yes | Asset part unit return ID |
|
|
144
141
|
|
|
145
142
|
##### Request Body
|
|
@@ -177,7 +174,6 @@ Content-Type: `application/json`
|
|
|
177
174
|
| Name | Location | Type | Required | Description |
|
|
178
175
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
179
176
|
|
|
180
|
-
|
|
181
177
|
| `id` | path | string | Yes | Asset part unit return ID |
|
|
182
178
|
|
|
183
179
|
##### Responses
|
|
@@ -201,7 +197,6 @@ Content-Type: `application/json`
|
|
|
201
197
|
| Property | Type | Required | Description |
|
|
202
198
|
| -------- | ---- | -------- | ----------- |
|
|
203
199
|
|
|
204
|
-
|
|
205
200
|
| `_id` | string | No | Unique identifier for the return |
|
|
206
201
|
|
|
207
202
|
| `returnNumber` | string | Yes | Unique return number |
|
|
@@ -263,7 +258,6 @@ Content-Type: `application/json`
|
|
|
263
258
|
| Property | Type | Required | Description |
|
|
264
259
|
| -------- | ---- | -------- | ----------- |
|
|
265
260
|
|
|
266
|
-
|
|
267
261
|
| `returnNumber` | string | Yes | Unique return number |
|
|
268
262
|
|
|
269
263
|
| `assetPartUnit` | string | Yes | Asset part unit ID being returned |
|
|
@@ -37,7 +37,7 @@ const result = await fetch(
|
|
|
37
37
|
Authorization: `Bearer ${apiKey}`,
|
|
38
38
|
"Content-Type": "application/json",
|
|
39
39
|
},
|
|
40
|
-
}
|
|
40
|
+
},
|
|
41
41
|
);
|
|
42
42
|
|
|
43
43
|
const data = await result.json();
|
|
@@ -99,7 +99,7 @@ const result = await fetch(
|
|
|
99
99
|
Authorization: `Bearer ${apiKey}`,
|
|
100
100
|
"Content-Type": "application/json",
|
|
101
101
|
},
|
|
102
|
-
}
|
|
102
|
+
},
|
|
103
103
|
);
|
|
104
104
|
|
|
105
105
|
const data = await result.json();
|
|
@@ -234,7 +234,7 @@ const result = await fetch(
|
|
|
234
234
|
Authorization: `Bearer ${apiKey}`,
|
|
235
235
|
"Content-Type": "application/json",
|
|
236
236
|
},
|
|
237
|
-
}
|
|
237
|
+
},
|
|
238
238
|
);
|
|
239
239
|
|
|
240
240
|
const data = await result.json();
|
|
@@ -27,7 +27,6 @@ No authentication required.
|
|
|
27
27
|
| Name | Location | Type | Required | Description |
|
|
28
28
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
29
29
|
|
|
30
|
-
|
|
31
30
|
| `params` | query | object | No | Query parameters for filtering return reasons |
|
|
32
31
|
|
|
33
32
|
##### Responses
|
|
@@ -67,7 +66,6 @@ Content-Type: `application/json`
|
|
|
67
66
|
| Name | Location | Type | Required | Description |
|
|
68
67
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
69
68
|
|
|
70
|
-
|
|
71
69
|
| `id` | path | string | Yes | No description |
|
|
72
70
|
|
|
73
71
|
##### Responses
|
|
@@ -87,7 +85,6 @@ Content-Type: `application/json`
|
|
|
87
85
|
| Name | Location | Type | Required | Description |
|
|
88
86
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
89
87
|
|
|
90
|
-
|
|
91
88
|
| `id` | path | string | Yes | No description |
|
|
92
89
|
|
|
93
90
|
##### Request Body
|
|
@@ -113,7 +110,6 @@ Content-Type: `application/json`
|
|
|
113
110
|
| Name | Location | Type | Required | Description |
|
|
114
111
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
115
112
|
|
|
116
|
-
|
|
117
113
|
| `id` | path | string | Yes | No description |
|
|
118
114
|
|
|
119
115
|
##### Responses
|
|
@@ -133,7 +129,6 @@ Result of finding return reasons
|
|
|
133
129
|
| Property | Type | Required | Description |
|
|
134
130
|
| -------- | ---- | -------- | ----------- |
|
|
135
131
|
|
|
136
|
-
|
|
137
132
|
| `data` | array | No | No description |
|
|
138
133
|
|
|
139
134
|
| `total_result` | number | No | Total number of return reasons |
|
|
@@ -163,7 +158,6 @@ Return reason schema
|
|
|
163
158
|
| Property | Type | Required | Description |
|
|
164
159
|
| -------- | ---- | -------- | ----------- |
|
|
165
160
|
|
|
166
|
-
|
|
167
161
|
| `_id` | string | No | Unique identifier for the return reason |
|
|
168
162
|
|
|
169
163
|
| `name` | string | No | Name of the return reason |
|
|
@@ -189,7 +183,6 @@ Body for creating a return reason
|
|
|
189
183
|
| Property | Type | Required | Description |
|
|
190
184
|
| -------- | ---- | -------- | ----------- |
|
|
191
185
|
|
|
192
|
-
|
|
193
186
|
| `name` | string | Yes | Name of the return reason |
|
|
194
187
|
|
|
195
188
|
| `local_name` | string | No | Localized name of the return reason |
|
|
@@ -215,7 +208,6 @@ Body for updating a return reason
|
|
|
215
208
|
| Property | Type | Required | Description |
|
|
216
209
|
| -------- | ---- | -------- | ----------- |
|
|
217
210
|
|
|
218
|
-
|
|
219
211
|
| `name` | string | No | Name of the return reason |
|
|
220
212
|
|
|
221
213
|
| `local_name` | string | No | Localized name of the return reason |
|
|
@@ -96,7 +96,7 @@ const result = await fetch(
|
|
|
96
96
|
Authorization: `Bearer ${apiKey}`,
|
|
97
97
|
"Content-Type": "application/json",
|
|
98
98
|
},
|
|
99
|
-
}
|
|
99
|
+
},
|
|
100
100
|
);
|
|
101
101
|
|
|
102
102
|
const data = await result.json();
|
|
@@ -231,7 +231,7 @@ const result = await fetch(
|
|
|
231
231
|
Authorization: `Bearer ${apiKey}`,
|
|
232
232
|
"Content-Type": "application/json",
|
|
233
233
|
},
|
|
234
|
-
}
|
|
234
|
+
},
|
|
235
235
|
);
|
|
236
236
|
|
|
237
237
|
const data = await result.json();
|