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.
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 +3 -4
  185. package/src/types/index.ts +14 -1
@@ -11,48 +11,41 @@ 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
  ### Find price list items
26
24
 
27
-
28
-
29
25
  ```typescript
30
-
31
26
  // GET /pricelistitem
32
27
 
33
28
  const params = {
34
-
35
29
  params: null, // Query parameters for filtering price list items
36
-
37
30
  };
38
31
 
39
- const result = await fetch(`${baseURL}/pricelistitem?${new URLSearchParams(params)}`, {
40
- method: 'GET',
41
- headers: {
42
- 'Authorization': `Bearer ${apiKey}`,
43
- 'Content-Type': 'application/json'
32
+ const result = await fetch(
33
+ `${baseURL}/pricelistitem?${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 price list item
70
61
 
71
-
72
-
73
62
  ```typescript
74
-
75
63
  // POST /pricelistitem
76
64
 
77
65
  const requestBody = {
@@ -80,59 +68,46 @@ const requestBody = {
80
68
  };
81
69
 
82
70
  const result = await fetch(`${baseURL}/pricelistitem`, {
83
- method: 'POST',
71
+ method: "POST",
84
72
  headers: {
85
- 'Authorization': `Bearer ${apiKey}`,
86
- 'Content-Type': 'application/json'
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 price list item by ID
106
86
 
107
-
108
-
109
87
  ```typescript
110
-
111
88
  // GET /pricelistitem/{id}
112
89
 
113
90
  const params = {
114
-
115
- id: 'example-value', // No description
116
-
91
+ id: "example-value", // No description
117
92
  };
118
93
 
119
- const result = await fetch(`${baseURL}/pricelistitem/{id}?${new URLSearchParams(params)}`, {
120
- method: 'GET',
121
- headers: {
122
- 'Authorization': `Bearer ${apiKey}`,
123
- 'Content-Type': 'application/json'
94
+ const result = await fetch(
95
+ `${baseURL}/pricelistitem/{id}?${new URLSearchParams(params)}`,
96
+ {
97
+ method: "GET",
98
+ headers: {
99
+ Authorization: `Bearer ${apiKey}`,
100
+ "Content-Type": "application/json",
101
+ },
124
102
  }
125
- });
103
+ );
126
104
 
127
105
  const data = await result.json();
128
106
  console.log(data);
129
-
130
-
131
-
132
107
  ```
133
108
 
134
-
135
109
  **Expected Response:**
110
+
136
111
  ```json
137
112
  {
138
113
  "success": true,
@@ -142,20 +117,16 @@ console.log(data);
142
117
  }
143
118
  ```
144
119
 
145
-
146
120
  ---
147
121
 
148
-
149
122
  ### Update a price list item
150
123
 
151
-
152
-
153
124
  ```typescript
154
125
 
155
126
  ```
156
127
 
157
-
158
128
  **Expected Response:**
129
+
159
130
  ```json
160
131
  {
161
132
  "success": true,
@@ -165,37 +136,30 @@ console.log(data);
165
136
  }
166
137
  ```
167
138
 
168
-
169
139
  ---
170
140
 
171
-
172
141
  ### Remove a price list item
173
142
 
174
-
175
-
176
143
  ```typescript
177
-
178
144
  // DELETE /pricelistitem/{id}
179
145
 
180
- const id = 'your-resource-id';
181
- const deletePath = '/pricelistitem/{id}'.replace('{id}', id);
146
+ const id = "your-resource-id";
147
+ const deletePath = "/pricelistitem/{id}".replace("{id}", id);
182
148
 
183
149
  const result = await fetch(`${baseURL}${deletePath}`, {
184
- method: 'DELETE',
150
+ method: "DELETE",
185
151
  headers: {
186
- 'Authorization': `Bearer ${apiKey}`,
187
- 'Content-Type': 'application/json'
188
- }
152
+ Authorization: `Bearer ${apiKey}`,
153
+ "Content-Type": "application/json",
154
+ },
189
155
  });
190
156
 
191
157
  const data = await result.json();
192
158
  console.log(data);
193
-
194
-
195
159
  ```
196
160
 
197
-
198
161
  **Expected Response:**
162
+
199
163
  ```json
200
164
  {
201
165
  "success": true,
@@ -205,27 +169,21 @@ console.log(data);
205
169
  }
206
170
  ```
207
171
 
208
-
209
172
  ---
210
173
 
211
-
212
-
213
-
214
174
  ## Using with Repzo SDK Service Types
215
175
 
216
176
  The Repzo SDK provides TypeScript interfaces for type safety:
217
177
 
218
178
  ```typescript
219
- import { Service } from 'repzo';
179
+ import { Service } from "repzo";
220
180
 
221
181
  // Example using SDK types
222
182
 
223
-
224
183
  async function example() {
225
184
  // Use the Service.Pricelistitem types for better type safety
226
185
  // This provides intellisense and compile-time type checking
227
186
  }
228
-
229
187
  ```
230
188
 
231
189
  ## Error Handling
@@ -233,11 +191,11 @@ async function example() {
233
191
  ```typescript
234
192
  try {
235
193
  const result = await fetch(`${baseURL}/endpoint`, {
236
- method: 'GET',
194
+ method: "GET",
237
195
  headers: {
238
- 'Authorization': `Bearer ${apiKey}`,
239
- 'Content-Type': 'application/json'
240
- }
196
+ Authorization: `Bearer ${apiKey}`,
197
+ "Content-Type": "application/json",
198
+ },
241
199
  });
242
200
 
243
201
  if (!result.ok) {
@@ -245,14 +203,14 @@ try {
245
203
  }
246
204
 
247
205
  const data = await result.json();
248
-
206
+
249
207
  if (!data.success) {
250
- throw new Error(data.error || 'API request failed');
208
+ throw new Error(data.error || "API request failed");
251
209
  }
252
-
210
+
253
211
  return data.data;
254
212
  } catch (error) {
255
- console.error('API request failed:', error);
213
+ console.error("API request failed:", error);
256
214
  throw error;
257
215
  }
258
216
  ```
@@ -268,18 +226,21 @@ const params = {
268
226
  // other filters...
269
227
  };
270
228
 
271
- const result = await fetch(`${baseURL}/endpoint?${new URLSearchParams(params)}`, {
272
- method: 'GET',
273
- headers: {
274
- 'Authorization': `Bearer ${apiKey}`,
275
- 'Content-Type': 'application/json'
229
+ const result = await fetch(
230
+ `${baseURL}/endpoint?${new URLSearchParams(params)}`,
231
+ {
232
+ method: "GET",
233
+ headers: {
234
+ Authorization: `Bearer ${apiKey}`,
235
+ "Content-Type": "application/json",
236
+ },
276
237
  }
277
- });
238
+ );
278
239
 
279
240
  const data = await result.json();
280
241
 
281
242
  // Access pagination info
282
- console.log('Total items:', data.paging.total);
283
- console.log('Current page:', data.paging.page);
284
- console.log('Total pages:', data.paging.pages);
285
- ```
243
+ console.log("Total items:", data.paging.total);
244
+ console.log("Current page:", data.paging.page);
245
+ console.log("Total pages:", data.paging.pages);
246
+ ```