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.
Files changed (185) hide show
  1. package/docs/README.md +16 -315
  2. package/docs/api/activity-ai-sales-order-examples.md +63 -112
  3. package/docs/api/activity-ai-sales-order.md +15 -215
  4. package/docs/api/activity-feedback-examples.md +82 -136
  5. package/docs/api/activity-feedback-v2-examples.md +86 -138
  6. package/docs/api/activity-feedback-v2.md +19 -263
  7. package/docs/api/activity-feedback.md +19 -263
  8. package/docs/api/activity-storecheck-examples.md +62 -101
  9. package/docs/api/activity-storecheck.md +13 -186
  10. package/docs/api/adjust-account-examples.md +50 -78
  11. package/docs/api/adjust-account.md +12 -117
  12. package/docs/api/adjust-inventory-examples.md +50 -78
  13. package/docs/api/adjust-inventory.md +16 -121
  14. package/docs/api/approval-request-examples.md +58 -97
  15. package/docs/api/approval-request.md +26 -189
  16. package/docs/api/approvals-examples.md +58 -97
  17. package/docs/api/approvals.md +26 -189
  18. package/docs/api/asset-examples.md +53 -95
  19. package/docs/api/asset-part-examples.md +62 -101
  20. package/docs/api/asset-part-receival-examples.md +62 -101
  21. package/docs/api/asset-part-receival.md +13 -186
  22. package/docs/api/asset-part-transfer-examples.md +63 -112
  23. package/docs/api/asset-part-transfer.md +15 -215
  24. package/docs/api/asset-part-type-examples.md +62 -101
  25. package/docs/api/asset-part-type.md +13 -186
  26. package/docs/api/asset-part-unit-examples.md +62 -101
  27. package/docs/api/asset-part-unit.md +13 -186
  28. package/docs/api/asset-part.md +13 -186
  29. package/docs/api/asset-type-examples.md +58 -97
  30. package/docs/api/asset-type.md +26 -189
  31. package/docs/api/asset-unit-examples.md +80 -147
  32. package/docs/api/asset-unit.md +19 -306
  33. package/docs/api/asset.md +26 -189
  34. package/docs/api/banks-examples.md +53 -95
  35. package/docs/api/banks.md +26 -189
  36. package/docs/api/bankslists-examples.md +58 -97
  37. package/docs/api/bankslists.md +26 -189
  38. package/docs/api/brand-examples.md +58 -97
  39. package/docs/api/brand.md +18 -181
  40. package/docs/api/category-examples.md +58 -97
  41. package/docs/api/category.md +18 -181
  42. package/docs/api/checks-examples.md +45 -76
  43. package/docs/api/checks.md +12 -117
  44. package/docs/api/client-channel-examples.md +62 -101
  45. package/docs/api/client-channel.md +20 -207
  46. package/docs/api/client-contact-examples.md +62 -101
  47. package/docs/api/client-contact.md +25 -233
  48. package/docs/api/client-examples.md +53 -95
  49. package/docs/api/client-location-examples.md +71 -126
  50. package/docs/api/client-location.md +19 -275
  51. package/docs/api/client.md +18 -181
  52. package/docs/api/contract-examples.md +58 -97
  53. package/docs/api/contract-installment-examples.md +84 -148
  54. package/docs/api/contract-installment.md +21 -303
  55. package/docs/api/contract.md +26 -189
  56. package/docs/api/custom-list-examples.md +58 -97
  57. package/docs/api/custom-list-item-examples.md +58 -97
  58. package/docs/api/custom-list-item.md +26 -189
  59. package/docs/api/custom-list.md +26 -189
  60. package/docs/api/custom-status-examples.md +58 -97
  61. package/docs/api/custom-status.md +26 -189
  62. package/docs/api/day-examples.md +45 -76
  63. package/docs/api/day.md +12 -117
  64. package/docs/api/feedback-options-examples.md +90 -153
  65. package/docs/api/feedback-options.md +23 -307
  66. package/docs/api/fullinvoices-examples.md +51 -83
  67. package/docs/api/fullinvoices.md +22 -162
  68. package/docs/api/index.md +99 -705
  69. package/docs/api/integration-action-log-examples.md +62 -101
  70. package/docs/api/integration-action-log.md +13 -186
  71. package/docs/api/integration-app-examples.md +51 -83
  72. package/docs/api/integration-app.md +16 -156
  73. package/docs/api/integration-command-log-examples.md +62 -101
  74. package/docs/api/integration-command-log.md +13 -186
  75. package/docs/api/inventory-adjustment-reason-examples.md +58 -97
  76. package/docs/api/inventory-adjustment-reason.md +26 -189
  77. package/docs/api/inventory-examples.md +35 -45
  78. package/docs/api/inventory.md +8 -53
  79. package/docs/api/mail-unsubscribe-examples.md +69 -124
  80. package/docs/api/mail-unsubscribe.md +13 -251
  81. package/docs/api/measureunit-examples.md +58 -97
  82. package/docs/api/measureunit-family-examples.md +58 -97
  83. package/docs/api/measureunit-family.md +18 -188
  84. package/docs/api/measureunit.md +20 -190
  85. package/docs/api/media-examples.md +53 -95
  86. package/docs/api/media-storage-examples.md +58 -97
  87. package/docs/api/media-storage.md +18 -181
  88. package/docs/api/media.md +18 -181
  89. package/docs/api/msl-examples.md +53 -95
  90. package/docs/api/msl-products-examples.md +58 -97
  91. package/docs/api/msl-products.md +26 -189
  92. package/docs/api/msl.md +26 -189
  93. package/docs/api/ocr-invoice-job-examples.md +74 -132
  94. package/docs/api/ocr-invoice-job-group-examples.md +73 -121
  95. package/docs/api/ocr-invoice-job-group.md +15 -215
  96. package/docs/api/ocr-invoice-job-page-examples.md +63 -112
  97. package/docs/api/ocr-invoice-job-page.md +15 -215
  98. package/docs/api/ocr-invoice-job-template-examples.md +62 -101
  99. package/docs/api/ocr-invoice-job-template.md +13 -186
  100. package/docs/api/ocr-invoice-job.md +19 -253
  101. package/docs/api/patch-action-examples.md +63 -112
  102. package/docs/api/patch-action.md +15 -215
  103. package/docs/api/payment-terms-examples.md +58 -97
  104. package/docs/api/payment-terms.md +28 -198
  105. package/docs/api/payments-examples.md +51 -83
  106. package/docs/api/payments.md +22 -162
  107. package/docs/api/pricelist-examples.md +58 -97
  108. package/docs/api/pricelist-item-examples.md +58 -97
  109. package/docs/api/pricelist-item.md +24 -208
  110. package/docs/api/pricelist.md +18 -181
  111. package/docs/api/product-examples.md +58 -97
  112. package/docs/api/product-group-examples.md +58 -97
  113. package/docs/api/product-group.md +18 -181
  114. package/docs/api/product-modifiers-group-examples.md +70 -125
  115. package/docs/api/product-modifiers-group.md +19 -275
  116. package/docs/api/product.md +20 -190
  117. package/docs/api/proforma-examples.md +51 -83
  118. package/docs/api/proforma.md +22 -162
  119. package/docs/api/quick-convert-to-pdf-examples.md +30 -41
  120. package/docs/api/quick-convert-to-pdf.md +6 -56
  121. package/docs/api/receiving-material-examples.md +51 -83
  122. package/docs/api/receiving-material.md +16 -156
  123. package/docs/api/refund-examples.md +46 -81
  124. package/docs/api/refund.md +16 -156
  125. package/docs/api/rep-balance-summary-examples.md +36 -46
  126. package/docs/api/rep-balance-summary.md +6 -53
  127. package/docs/api/rep-examples.md +53 -95
  128. package/docs/api/rep.md +18 -181
  129. package/docs/api/return-asset-part-unit-examples.md +62 -101
  130. package/docs/api/return-asset-part-unit.md +13 -186
  131. package/docs/api/return-reason-examples.md +58 -97
  132. package/docs/api/return-reason.md +18 -181
  133. package/docs/api/route-examples.md +53 -95
  134. package/docs/api/route.md +18 -181
  135. package/docs/api/safe-invoice-serial-counter-examples.md +72 -127
  136. package/docs/api/safe-invoice-serial-counter.md +17 -266
  137. package/docs/api/settings-examples.md +47 -70
  138. package/docs/api/settings.md +18 -123
  139. package/docs/api/settlement-examples.md +50 -78
  140. package/docs/api/settlement.md +12 -117
  141. package/docs/api/speciality-examples.md +70 -125
  142. package/docs/api/speciality.md +17 -266
  143. package/docs/api/store-asset-part-unit-examples.md +62 -101
  144. package/docs/api/store-asset-part-unit.md +13 -186
  145. package/docs/api/storecheck-template-examples.md +58 -97
  146. package/docs/api/storecheck-template.md +18 -181
  147. package/docs/api/subcategory-examples.md +58 -97
  148. package/docs/api/subcategory.md +18 -181
  149. package/docs/api/supplier-examples.md +58 -97
  150. package/docs/api/supplier.md +26 -189
  151. package/docs/api/svix-integration-examples.md +62 -101
  152. package/docs/api/svix-integration.md +13 -186
  153. package/docs/api/tag-examples.md +53 -95
  154. package/docs/api/tag.md +18 -181
  155. package/docs/api/tax-examples.md +53 -95
  156. package/docs/api/tax.md +18 -181
  157. package/docs/api/team-examples.md +53 -95
  158. package/docs/api/team.md +18 -181
  159. package/docs/api/transfer-examples.md +51 -83
  160. package/docs/api/transfer.md +16 -156
  161. package/docs/api/update-integration-meta-examples.md +63 -112
  162. package/docs/api/update-integration-meta.md +15 -215
  163. package/docs/api/variant-examples.md +58 -97
  164. package/docs/api/variant.md +20 -183
  165. package/docs/api/visit-examples.md +46 -81
  166. package/docs/api/visit.md +22 -162
  167. package/docs/api/warehouse-examples.md +58 -97
  168. package/docs/api/warehouse.md +18 -181
  169. package/docs/api/workorder-category-examples.md +76 -141
  170. package/docs/api/workorder-category.md +19 -305
  171. package/docs/api/workorder-examples.md +58 -97
  172. package/docs/api/workorder-portal-examples.md +75 -132
  173. package/docs/api/workorder-portal-link-examples.md +70 -145
  174. package/docs/api/workorder-portal-link.md +23 -336
  175. package/docs/api/workorder-portal.md +19 -271
  176. package/docs/api/workorder-request-examples.md +58 -97
  177. package/docs/api/workorder-request.md +26 -189
  178. package/docs/api/workorder.md +26 -189
  179. package/docs/generated/index.html +1 -1
  180. package/docs/generated/repzo-api-complete.yaml +2585 -2585
  181. package/lib/index.d.ts +180 -0
  182. package/lib/index.js +90 -0
  183. package/lib/types/index.d.ts +13393 -14636
  184. package/package.json +2 -3
  185. package/src/types/index.ts +14 -1
@@ -11,62 +11,55 @@ npm install repzo
11
11
  ## Basic Setup
12
12
 
13
13
  ```typescript
14
- import { Service } from 'repzo';
14
+ import { Service } from "repzo";
15
15
 
16
16
  // Initialize with your API key
17
- const apiKey = 'your-api-key';
18
- const baseURL = 'https://api.repzo.me/v1';
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
  ### Get all safe invoice serial counters
26
24
 
27
-
28
25
  Retrieve a list of all safe invoice serial counters with optional filtering and pagination
29
26
 
30
-
31
27
  ```typescript
32
-
33
28
  // GET /safe-invoice-serial-counter
34
29
 
35
30
  const params = {
36
-
37
31
  page: 1, // Page number for pagination
38
32
 
39
33
  per_page: 1, // Number of items per page
40
34
 
41
- sort: 'example-value', // Sort field
35
+ sort: "example-value", // Sort field
42
36
 
43
37
  company_namespace: null, // Company namespace for filtering
44
38
 
45
- rep: 'example-value', // Filter by representative ID
39
+ rep: "example-value", // Filter by representative ID
46
40
 
47
- warehouse: 'example-value', // Filter by warehouse ID
41
+ warehouse: "example-value", // Filter by warehouse ID
48
42
 
49
43
  _id: null, // Filter by ID
50
-
51
44
  };
52
45
 
53
- const result = await fetch(`${baseURL}/safe-invoice-serial-counter?${new URLSearchParams(params)}`, {
54
- method: 'GET',
55
- headers: {
56
- 'Authorization': `Bearer ${apiKey}`,
57
- 'Content-Type': 'application/json'
46
+ const result = await fetch(
47
+ `${baseURL}/safe-invoice-serial-counter?${new URLSearchParams(params)}`,
48
+ {
49
+ method: "GET",
50
+ headers: {
51
+ Authorization: `Bearer ${apiKey}`,
52
+ "Content-Type": "application/json",
53
+ },
58
54
  }
59
- });
55
+ );
60
56
 
61
57
  const data = await result.json();
62
58
  console.log(data);
63
-
64
-
65
-
66
59
  ```
67
60
 
68
-
69
61
  **Expected Response:**
62
+
70
63
  ```json
71
64
  {
72
65
  "success": true,
@@ -76,18 +69,13 @@ console.log(data);
76
69
  }
77
70
  ```
78
71
 
79
-
80
72
  ---
81
73
 
82
-
83
74
  ### Create a new safe invoice serial counter
84
75
 
85
-
86
76
  Create a new safe invoice serial counter entry
87
77
 
88
-
89
78
  ```typescript
90
-
91
79
  // POST /safe-invoice-serial-counter
92
80
 
93
81
  const requestBody = {
@@ -96,61 +84,48 @@ const requestBody = {
96
84
  };
97
85
 
98
86
  const result = await fetch(`${baseURL}/safe-invoice-serial-counter`, {
99
- method: 'POST',
87
+ method: "POST",
100
88
  headers: {
101
- 'Authorization': `Bearer ${apiKey}`,
102
- 'Content-Type': 'application/json'
89
+ Authorization: `Bearer ${apiKey}`,
90
+ "Content-Type": "application/json",
103
91
  },
104
- body: JSON.stringify(requestBody)
92
+ body: JSON.stringify(requestBody),
105
93
  });
106
94
 
107
95
  const data = await result.json();
108
96
  console.log(data);
109
-
110
-
111
-
112
97
  ```
113
98
 
114
-
115
-
116
99
  ---
117
100
 
118
-
119
-
120
-
121
101
  ### Get safe invoice serial counter by ID
122
102
 
123
-
124
103
  Retrieve a specific safe invoice serial counter by its ID
125
104
 
126
-
127
105
  ```typescript
128
-
129
106
  // GET /safe-invoice-serial-counter/{id}
130
107
 
131
108
  const params = {
132
-
133
- id: 'example-value', // Safe invoice serial counter ID
134
-
109
+ id: "example-value", // Safe invoice serial counter ID
135
110
  };
136
111
 
137
- const result = await fetch(`${baseURL}/safe-invoice-serial-counter/{id}?${new URLSearchParams(params)}`, {
138
- method: 'GET',
139
- headers: {
140
- 'Authorization': `Bearer ${apiKey}`,
141
- 'Content-Type': 'application/json'
112
+ const result = await fetch(
113
+ `${baseURL}/safe-invoice-serial-counter/{id}?${new URLSearchParams(params)}`,
114
+ {
115
+ method: "GET",
116
+ headers: {
117
+ Authorization: `Bearer ${apiKey}`,
118
+ "Content-Type": "application/json",
119
+ },
142
120
  }
143
- });
121
+ );
144
122
 
145
123
  const data = await result.json();
146
124
  console.log(data);
147
-
148
-
149
-
150
125
  ```
151
126
 
152
-
153
127
  **Expected Response:**
128
+
154
129
  ```json
155
130
  {
156
131
  "success": true,
@@ -160,47 +135,37 @@ console.log(data);
160
135
  }
161
136
  ```
162
137
 
163
-
164
138
  ---
165
139
 
166
-
167
140
  ### Update safe invoice serial counter
168
141
 
169
-
170
142
  Update an existing safe invoice serial counter
171
143
 
172
-
173
144
  ```typescript
174
-
175
145
  // PATCH /safe-invoice-serial-counter/{id}
176
146
 
177
- const id = 'your-resource-id';
178
- const updatePath = '/safe-invoice-serial-counter/{id}'.replace('{id}', id);
179
-
180
-
147
+ const id = "your-resource-id";
148
+ const updatePath = "/safe-invoice-serial-counter/{id}".replace("{id}", id);
181
149
 
182
150
  const updateData = {
183
151
  // Add your update properties here
184
152
  };
185
153
 
186
154
  const result = await fetch(`${baseURL}${updatePath}`, {
187
- method: 'PATCH',
155
+ method: "PATCH",
188
156
  headers: {
189
- 'Authorization': `Bearer ${apiKey}`,
190
- 'Content-Type': 'application/json'
157
+ Authorization: `Bearer ${apiKey}`,
158
+ "Content-Type": "application/json",
191
159
  },
192
- body: JSON.stringify(updateData)
160
+ body: JSON.stringify(updateData),
193
161
  });
194
162
 
195
163
  const data = await result.json();
196
164
  console.log(data);
197
-
198
-
199
-
200
165
  ```
201
166
 
202
-
203
167
  **Expected Response:**
168
+
204
169
  ```json
205
170
  {
206
171
  "success": true,
@@ -210,39 +175,32 @@ console.log(data);
210
175
  }
211
176
  ```
212
177
 
213
-
214
178
  ---
215
179
 
216
-
217
180
  ### Delete safe invoice serial counter
218
181
 
219
-
220
182
  Delete a safe invoice serial counter by ID
221
183
 
222
-
223
184
  ```typescript
224
-
225
185
  // DELETE /safe-invoice-serial-counter/{id}
226
186
 
227
- const id = 'your-resource-id';
228
- const deletePath = '/safe-invoice-serial-counter/{id}'.replace('{id}', id);
187
+ const id = "your-resource-id";
188
+ const deletePath = "/safe-invoice-serial-counter/{id}".replace("{id}", id);
229
189
 
230
190
  const result = await fetch(`${baseURL}${deletePath}`, {
231
- method: 'DELETE',
191
+ method: "DELETE",
232
192
  headers: {
233
- 'Authorization': `Bearer ${apiKey}`,
234
- 'Content-Type': 'application/json'
235
- }
193
+ Authorization: `Bearer ${apiKey}`,
194
+ "Content-Type": "application/json",
195
+ },
236
196
  });
237
197
 
238
198
  const data = await result.json();
239
199
  console.log(data);
240
-
241
-
242
200
  ```
243
201
 
244
-
245
202
  **Expected Response:**
203
+
246
204
  ```json
247
205
  {
248
206
  "success": true,
@@ -252,20 +210,13 @@ console.log(data);
252
210
  }
253
211
  ```
254
212
 
255
-
256
213
  ---
257
214
 
258
-
259
-
260
-
261
215
  ### Get next serial number
262
216
 
263
-
264
217
  Get the next available serial number for invoice generation
265
218
 
266
-
267
219
  ```typescript
268
-
269
220
  // POST /safe-invoice-serial-counter/next
270
221
 
271
222
  const requestBody = {
@@ -274,23 +225,20 @@ const requestBody = {
274
225
  };
275
226
 
276
227
  const result = await fetch(`${baseURL}/safe-invoice-serial-counter/next`, {
277
- method: 'POST',
228
+ method: "POST",
278
229
  headers: {
279
- 'Authorization': `Bearer ${apiKey}`,
280
- 'Content-Type': 'application/json'
230
+ Authorization: `Bearer ${apiKey}`,
231
+ "Content-Type": "application/json",
281
232
  },
282
- body: JSON.stringify(requestBody)
233
+ body: JSON.stringify(requestBody),
283
234
  });
284
235
 
285
236
  const data = await result.json();
286
237
  console.log(data);
287
-
288
-
289
-
290
238
  ```
291
239
 
292
-
293
240
  **Expected Response:**
241
+
294
242
  ```json
295
243
  {
296
244
  "success": true,
@@ -300,27 +248,21 @@ console.log(data);
300
248
  }
301
249
  ```
302
250
 
303
-
304
251
  ---
305
252
 
306
-
307
-
308
-
309
253
  ## Using with Repzo SDK Service Types
310
254
 
311
255
  The Repzo SDK provides TypeScript interfaces for type safety:
312
256
 
313
257
  ```typescript
314
- import { Service } from 'repzo';
258
+ import { Service } from "repzo";
315
259
 
316
260
  // Example using SDK types
317
261
 
318
-
319
262
  async function example() {
320
263
  // Use the Service.Safeinvoiceserialcounter types for better type safety
321
264
  // This provides intellisense and compile-time type checking
322
265
  }
323
-
324
266
  ```
325
267
 
326
268
  ## Error Handling
@@ -328,11 +270,11 @@ async function example() {
328
270
  ```typescript
329
271
  try {
330
272
  const result = await fetch(`${baseURL}/endpoint`, {
331
- method: 'GET',
273
+ method: "GET",
332
274
  headers: {
333
- 'Authorization': `Bearer ${apiKey}`,
334
- 'Content-Type': 'application/json'
335
- }
275
+ Authorization: `Bearer ${apiKey}`,
276
+ "Content-Type": "application/json",
277
+ },
336
278
  });
337
279
 
338
280
  if (!result.ok) {
@@ -340,14 +282,14 @@ try {
340
282
  }
341
283
 
342
284
  const data = await result.json();
343
-
285
+
344
286
  if (!data.success) {
345
- throw new Error(data.error || 'API request failed');
287
+ throw new Error(data.error || "API request failed");
346
288
  }
347
-
289
+
348
290
  return data.data;
349
291
  } catch (error) {
350
- console.error('API request failed:', error);
292
+ console.error("API request failed:", error);
351
293
  throw error;
352
294
  }
353
295
  ```
@@ -363,18 +305,21 @@ const params = {
363
305
  // other filters...
364
306
  };
365
307
 
366
- const result = await fetch(`${baseURL}/endpoint?${new URLSearchParams(params)}`, {
367
- method: 'GET',
368
- headers: {
369
- 'Authorization': `Bearer ${apiKey}`,
370
- 'Content-Type': 'application/json'
308
+ const result = await fetch(
309
+ `${baseURL}/endpoint?${new URLSearchParams(params)}`,
310
+ {
311
+ method: "GET",
312
+ headers: {
313
+ Authorization: `Bearer ${apiKey}`,
314
+ "Content-Type": "application/json",
315
+ },
371
316
  }
372
- });
317
+ );
373
318
 
374
319
  const data = await result.json();
375
320
 
376
321
  // Access pagination info
377
- console.log('Total items:', data.paging.total);
378
- console.log('Current page:', data.paging.page);
379
- console.log('Total pages:', data.paging.pages);
380
- ```
322
+ console.log("Total items:", data.paging.total);
323
+ console.log("Current page:", data.paging.page);
324
+ console.log("Total pages:", data.paging.pages);
325
+ ```