repzo 1.0.141 → 1.0.143
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/README.md +16 -315
- package/docs/api/activity-ai-sales-order-examples.md +63 -112
- package/docs/api/activity-ai-sales-order.md +15 -215
- package/docs/api/activity-feedback-examples.md +82 -136
- package/docs/api/activity-feedback-v2-examples.md +86 -138
- package/docs/api/activity-feedback-v2.md +19 -263
- package/docs/api/activity-feedback.md +19 -263
- package/docs/api/activity-storecheck-examples.md +62 -101
- package/docs/api/activity-storecheck.md +13 -186
- package/docs/api/adjust-account-examples.md +50 -78
- package/docs/api/adjust-account.md +12 -117
- package/docs/api/adjust-inventory-examples.md +50 -78
- package/docs/api/adjust-inventory.md +16 -121
- package/docs/api/approval-request-examples.md +58 -97
- package/docs/api/approval-request.md +26 -189
- package/docs/api/approvals-examples.md +58 -97
- package/docs/api/approvals.md +26 -189
- package/docs/api/asset-examples.md +53 -95
- package/docs/api/asset-part-examples.md +62 -101
- package/docs/api/asset-part-receival-examples.md +62 -101
- package/docs/api/asset-part-receival.md +13 -186
- package/docs/api/asset-part-transfer-examples.md +63 -112
- package/docs/api/asset-part-transfer.md +15 -215
- package/docs/api/asset-part-type-examples.md +62 -101
- package/docs/api/asset-part-type.md +13 -186
- package/docs/api/asset-part-unit-examples.md +62 -101
- package/docs/api/asset-part-unit.md +13 -186
- package/docs/api/asset-part.md +13 -186
- package/docs/api/asset-type-examples.md +58 -97
- package/docs/api/asset-type.md +26 -189
- package/docs/api/asset-unit-examples.md +80 -147
- package/docs/api/asset-unit.md +19 -306
- package/docs/api/asset.md +26 -189
- package/docs/api/banks-examples.md +53 -95
- package/docs/api/banks.md +26 -189
- package/docs/api/bankslists-examples.md +58 -97
- package/docs/api/bankslists.md +26 -189
- package/docs/api/brand-examples.md +58 -97
- package/docs/api/brand.md +18 -181
- package/docs/api/category-examples.md +58 -97
- package/docs/api/category.md +18 -181
- package/docs/api/checks-examples.md +45 -76
- package/docs/api/checks.md +12 -117
- package/docs/api/client-channel-examples.md +62 -101
- package/docs/api/client-channel.md +20 -207
- package/docs/api/client-contact-examples.md +62 -101
- package/docs/api/client-contact.md +25 -233
- package/docs/api/client-examples.md +53 -95
- package/docs/api/client-location-examples.md +71 -126
- package/docs/api/client-location.md +19 -275
- package/docs/api/client.md +18 -181
- package/docs/api/contract-examples.md +58 -97
- package/docs/api/contract-installment-examples.md +84 -148
- package/docs/api/contract-installment.md +21 -303
- package/docs/api/contract.md +26 -189
- package/docs/api/custom-list-examples.md +58 -97
- package/docs/api/custom-list-item-examples.md +58 -97
- package/docs/api/custom-list-item.md +26 -189
- package/docs/api/custom-list.md +26 -189
- package/docs/api/custom-status-examples.md +58 -97
- package/docs/api/custom-status.md +26 -189
- package/docs/api/day-examples.md +45 -76
- package/docs/api/day.md +12 -117
- package/docs/api/feedback-options-examples.md +90 -153
- package/docs/api/feedback-options.md +23 -307
- package/docs/api/fullinvoices-examples.md +51 -83
- package/docs/api/fullinvoices.md +22 -162
- package/docs/api/index.md +99 -705
- package/docs/api/integration-action-log-examples.md +62 -101
- package/docs/api/integration-action-log.md +13 -186
- package/docs/api/integration-app-examples.md +51 -83
- package/docs/api/integration-app.md +16 -156
- package/docs/api/integration-command-log-examples.md +62 -101
- package/docs/api/integration-command-log.md +13 -186
- package/docs/api/inventory-adjustment-reason-examples.md +58 -97
- package/docs/api/inventory-adjustment-reason.md +26 -189
- package/docs/api/inventory-examples.md +35 -45
- package/docs/api/inventory.md +8 -53
- package/docs/api/mail-unsubscribe-examples.md +69 -124
- package/docs/api/mail-unsubscribe.md +13 -251
- package/docs/api/measureunit-examples.md +58 -97
- package/docs/api/measureunit-family-examples.md +58 -97
- package/docs/api/measureunit-family.md +18 -188
- package/docs/api/measureunit.md +20 -190
- package/docs/api/media-examples.md +53 -95
- package/docs/api/media-storage-examples.md +58 -97
- package/docs/api/media-storage.md +18 -181
- package/docs/api/media.md +18 -181
- package/docs/api/msl-examples.md +53 -95
- package/docs/api/msl-products-examples.md +58 -97
- package/docs/api/msl-products.md +26 -189
- package/docs/api/msl.md +26 -189
- package/docs/api/ocr-invoice-job-examples.md +74 -132
- package/docs/api/ocr-invoice-job-group-examples.md +73 -121
- package/docs/api/ocr-invoice-job-group.md +15 -215
- package/docs/api/ocr-invoice-job-page-examples.md +63 -112
- package/docs/api/ocr-invoice-job-page.md +15 -215
- package/docs/api/ocr-invoice-job-template-examples.md +62 -101
- package/docs/api/ocr-invoice-job-template.md +13 -186
- package/docs/api/ocr-invoice-job.md +19 -253
- package/docs/api/patch-action-examples.md +63 -112
- package/docs/api/patch-action.md +15 -215
- package/docs/api/payment-terms-examples.md +58 -97
- package/docs/api/payment-terms.md +28 -198
- package/docs/api/payments-examples.md +51 -83
- package/docs/api/payments.md +22 -162
- package/docs/api/pricelist-examples.md +58 -97
- package/docs/api/pricelist-item-examples.md +58 -97
- package/docs/api/pricelist-item.md +24 -208
- package/docs/api/pricelist.md +18 -181
- package/docs/api/product-examples.md +58 -97
- package/docs/api/product-group-examples.md +58 -97
- package/docs/api/product-group.md +18 -181
- package/docs/api/product-modifiers-group-examples.md +70 -125
- package/docs/api/product-modifiers-group.md +19 -275
- package/docs/api/product.md +20 -190
- package/docs/api/proforma-examples.md +51 -83
- package/docs/api/proforma.md +22 -162
- package/docs/api/quick-convert-to-pdf-examples.md +30 -41
- package/docs/api/quick-convert-to-pdf.md +6 -56
- package/docs/api/receiving-material-examples.md +51 -83
- package/docs/api/receiving-material.md +16 -156
- package/docs/api/refund-examples.md +46 -81
- package/docs/api/refund.md +16 -156
- package/docs/api/rep-balance-summary-examples.md +36 -46
- package/docs/api/rep-balance-summary.md +6 -53
- package/docs/api/rep-examples.md +53 -95
- package/docs/api/rep.md +18 -181
- package/docs/api/return-asset-part-unit-examples.md +62 -101
- package/docs/api/return-asset-part-unit.md +13 -186
- package/docs/api/return-reason-examples.md +58 -97
- package/docs/api/return-reason.md +18 -181
- package/docs/api/route-examples.md +53 -95
- package/docs/api/route.md +18 -181
- package/docs/api/safe-invoice-serial-counter-examples.md +72 -127
- package/docs/api/safe-invoice-serial-counter.md +17 -266
- package/docs/api/settings-examples.md +47 -70
- package/docs/api/settings.md +18 -123
- package/docs/api/settlement-examples.md +50 -78
- package/docs/api/settlement.md +12 -117
- package/docs/api/speciality-examples.md +70 -125
- package/docs/api/speciality.md +17 -266
- package/docs/api/store-asset-part-unit-examples.md +62 -101
- package/docs/api/store-asset-part-unit.md +13 -186
- package/docs/api/storecheck-template-examples.md +58 -97
- package/docs/api/storecheck-template.md +18 -181
- package/docs/api/subcategory-examples.md +58 -97
- package/docs/api/subcategory.md +18 -181
- package/docs/api/supplier-examples.md +58 -97
- package/docs/api/supplier.md +26 -189
- package/docs/api/svix-integration-examples.md +62 -101
- package/docs/api/svix-integration.md +13 -186
- package/docs/api/tag-examples.md +53 -95
- package/docs/api/tag.md +18 -181
- package/docs/api/tax-examples.md +53 -95
- package/docs/api/tax.md +18 -181
- package/docs/api/team-examples.md +53 -95
- package/docs/api/team.md +18 -181
- package/docs/api/transfer-examples.md +51 -83
- package/docs/api/transfer.md +16 -156
- package/docs/api/update-integration-meta-examples.md +63 -112
- package/docs/api/update-integration-meta.md +15 -215
- package/docs/api/variant-examples.md +58 -97
- package/docs/api/variant.md +20 -183
- package/docs/api/visit-examples.md +46 -81
- package/docs/api/visit.md +22 -162
- package/docs/api/warehouse-examples.md +58 -97
- package/docs/api/warehouse.md +18 -181
- package/docs/api/workorder-category-examples.md +76 -141
- package/docs/api/workorder-category.md +19 -305
- package/docs/api/workorder-examples.md +58 -97
- package/docs/api/workorder-portal-examples.md +75 -132
- package/docs/api/workorder-portal-link-examples.md +70 -145
- package/docs/api/workorder-portal-link.md +23 -336
- package/docs/api/workorder-portal.md +19 -271
- package/docs/api/workorder-request-examples.md +58 -97
- package/docs/api/workorder-request.md +26 -189
- package/docs/api/workorder.md +26 -189
- package/docs/generated/index.html +1 -1
- package/docs/generated/repzo-api-complete.yaml +2585 -2585
- package/lib/index.d.ts +180 -0
- package/lib/index.js +90 -0
- package/lib/types/index.d.ts +13393 -14636
- package/package.json +3 -4
- package/src/types/index.ts +14 -1
|
@@ -6,238 +6,131 @@ OpenAPI specification for Repzo Payment Terms endpoints.
|
|
|
6
6
|
|
|
7
7
|
## Overview
|
|
8
8
|
|
|
9
|
-
|
|
10
9
|
### Base URLs
|
|
11
10
|
|
|
12
|
-
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
11
|
+
- \*\*\*\*: `https://sv.api.repzo.me`
|
|
17
12
|
|
|
18
13
|
## Authentication
|
|
19
14
|
|
|
20
|
-
|
|
21
15
|
No authentication required.
|
|
22
16
|
|
|
23
|
-
|
|
24
17
|
## Endpoints
|
|
25
18
|
|
|
26
|
-
|
|
27
19
|
### `/paymentterms`
|
|
28
20
|
|
|
29
|
-
|
|
30
21
|
#### GET /paymentterms
|
|
31
22
|
|
|
32
23
|
**Summary:** Find payment terms
|
|
33
24
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
25
|
##### Parameters
|
|
40
26
|
|
|
41
27
|
| Name | Location | Type | Required | Description |
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
| `params` | query | object | No | Query parameters for filtering payment terms |
|
|
45
|
-
|
|
46
|
-
|
|
28
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
47
29
|
|
|
48
30
|
|
|
31
|
+
| `params` | query | object | No | Query parameters for filtering payment terms |
|
|
49
32
|
|
|
50
33
|
##### Responses
|
|
51
34
|
|
|
52
|
-
|
|
53
35
|
**200** - A list of payment terms
|
|
54
36
|
|
|
55
|
-
|
|
56
|
-
|
|
57
37
|
Content-Type: `application/json`
|
|
58
38
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
39
|
---
|
|
64
40
|
|
|
65
|
-
|
|
66
41
|
#### POST /paymentterms
|
|
67
42
|
|
|
68
43
|
**Summary:** Create a payment term
|
|
69
44
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
45
|
##### Request Body
|
|
78
46
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
47
|
**Content Types:**
|
|
83
48
|
|
|
84
49
|
- `application/json`
|
|
85
50
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
51
|
##### Responses
|
|
90
52
|
|
|
91
|
-
|
|
92
53
|
**201** - Payment term created
|
|
93
54
|
|
|
94
|
-
|
|
95
|
-
|
|
96
55
|
Content-Type: `application/json`
|
|
97
56
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
57
|
---
|
|
103
58
|
|
|
104
|
-
|
|
105
|
-
|
|
106
59
|
### `/paymentterms/{id}`
|
|
107
60
|
|
|
108
|
-
|
|
109
61
|
#### GET /paymentterms/{id}
|
|
110
62
|
|
|
111
63
|
**Summary:** Get a payment term by ID
|
|
112
64
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
65
|
##### Parameters
|
|
119
66
|
|
|
120
67
|
| Name | Location | Type | Required | Description |
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
| `id` | path | string | Yes | No description |
|
|
124
|
-
|
|
125
|
-
|
|
68
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
126
69
|
|
|
127
70
|
|
|
71
|
+
| `id` | path | string | Yes | No description |
|
|
128
72
|
|
|
129
73
|
##### Responses
|
|
130
74
|
|
|
131
|
-
|
|
132
75
|
**200** - Payment term details
|
|
133
76
|
|
|
134
|
-
|
|
135
|
-
|
|
136
77
|
Content-Type: `application/json`
|
|
137
78
|
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
79
|
---
|
|
143
80
|
|
|
144
|
-
|
|
145
81
|
#### PUT /paymentterms/{id}
|
|
146
82
|
|
|
147
83
|
**Summary:** Update a payment term
|
|
148
84
|
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
85
|
##### Parameters
|
|
155
86
|
|
|
156
87
|
| Name | Location | Type | Required | Description |
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
| `id` | path | string | Yes | No description |
|
|
160
|
-
|
|
88
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
161
89
|
|
|
162
90
|
|
|
91
|
+
| `id` | path | string | Yes | No description |
|
|
163
92
|
|
|
164
93
|
##### Request Body
|
|
165
94
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
95
|
**Content Types:**
|
|
170
96
|
|
|
171
97
|
- `application/json`
|
|
172
98
|
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
99
|
##### Responses
|
|
177
100
|
|
|
178
|
-
|
|
179
101
|
**200** - Payment term updated
|
|
180
102
|
|
|
181
|
-
|
|
182
|
-
|
|
183
103
|
Content-Type: `application/json`
|
|
184
104
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
105
|
---
|
|
190
106
|
|
|
191
|
-
|
|
192
107
|
#### DELETE /paymentterms/{id}
|
|
193
108
|
|
|
194
109
|
**Summary:** Remove a payment term
|
|
195
110
|
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
111
|
##### Parameters
|
|
202
112
|
|
|
203
113
|
| Name | Location | Type | Required | Description |
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
| `id` | path | string | Yes | No description |
|
|
207
|
-
|
|
208
|
-
|
|
114
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
209
115
|
|
|
210
116
|
|
|
117
|
+
| `id` | path | string | Yes | No description |
|
|
211
118
|
|
|
212
119
|
##### Responses
|
|
213
120
|
|
|
214
|
-
|
|
215
121
|
**200** - Payment term removed
|
|
216
122
|
|
|
217
|
-
|
|
218
|
-
|
|
219
123
|
Content-Type: `application/json`
|
|
220
124
|
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
125
|
---
|
|
226
126
|
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
127
|
## Data Models
|
|
231
128
|
|
|
232
|
-
|
|
233
|
-
|
|
234
129
|
### PaymentTermFindResult
|
|
235
130
|
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
131
|
| Property | Type | Required | Description |
|
|
240
|
-
|
|
132
|
+
| -------- | ---- | -------- | ----------- |
|
|
133
|
+
|
|
241
134
|
|
|
242
135
|
| `success` | boolean | No | No description |
|
|
243
136
|
|
|
@@ -245,18 +138,11 @@ Content-Type: `application/json`
|
|
|
245
138
|
|
|
246
139
|
| `pagination` | object | No | No description |
|
|
247
140
|
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
141
|
### PaymentTermCreateBody
|
|
254
142
|
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
143
|
| Property | Type | Required | Description |
|
|
259
|
-
|
|
144
|
+
| -------- | ---- | -------- | ----------- |
|
|
145
|
+
|
|
260
146
|
|
|
261
147
|
| `name` | string | Yes | Name of the payment term |
|
|
262
148
|
|
|
@@ -270,52 +156,31 @@ Content-Type: `application/json`
|
|
|
270
156
|
|
|
271
157
|
| `is_active` | boolean | No | Whether the payment term is active |
|
|
272
158
|
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
159
|
### PaymentTermCreateResult
|
|
279
160
|
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
161
|
| Property | Type | Required | Description |
|
|
284
|
-
|
|
162
|
+
| -------- | ---- | -------- | ----------- |
|
|
163
|
+
|
|
285
164
|
|
|
286
165
|
| `success` | boolean | No | No description |
|
|
287
166
|
|
|
288
167
|
| `result` | object | No | No description |
|
|
289
168
|
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
169
|
### PaymentTermGetResult
|
|
296
170
|
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
171
|
| Property | Type | Required | Description |
|
|
301
|
-
|
|
172
|
+
| -------- | ---- | -------- | ----------- |
|
|
173
|
+
|
|
302
174
|
|
|
303
175
|
| `success` | boolean | No | No description |
|
|
304
176
|
|
|
305
177
|
| `result` | object | No | No description |
|
|
306
178
|
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
179
|
### PaymentTermUpdateBody
|
|
313
180
|
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
181
|
| Property | Type | Required | Description |
|
|
318
|
-
|
|
182
|
+
| -------- | ---- | -------- | ----------- |
|
|
183
|
+
|
|
319
184
|
|
|
320
185
|
| `name` | string | No | Name of the payment term |
|
|
321
186
|
|
|
@@ -329,52 +194,31 @@ Content-Type: `application/json`
|
|
|
329
194
|
|
|
330
195
|
| `is_active` | boolean | No | Whether the payment term is active |
|
|
331
196
|
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
197
|
### PaymentTermUpdateResult
|
|
338
198
|
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
199
|
| Property | Type | Required | Description |
|
|
343
|
-
|
|
200
|
+
| -------- | ---- | -------- | ----------- |
|
|
201
|
+
|
|
344
202
|
|
|
345
203
|
| `success` | boolean | No | No description |
|
|
346
204
|
|
|
347
205
|
| `result` | object | No | No description |
|
|
348
206
|
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
207
|
### PaymentTermRemoveResult
|
|
355
208
|
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
209
|
| Property | Type | Required | Description |
|
|
360
|
-
|
|
210
|
+
| -------- | ---- | -------- | ----------- |
|
|
211
|
+
|
|
361
212
|
|
|
362
213
|
| `success` | boolean | No | No description |
|
|
363
214
|
|
|
364
215
|
| `result` | object | No | No description |
|
|
365
216
|
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
217
|
### PaymentTerm
|
|
372
218
|
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
219
|
| Property | Type | Required | Description |
|
|
377
|
-
|
|
220
|
+
| -------- | ---- | -------- | ----------- |
|
|
221
|
+
|
|
378
222
|
|
|
379
223
|
| `_id` | string | No | Unique identifier |
|
|
380
224
|
|
|
@@ -396,18 +240,11 @@ Content-Type: `application/json`
|
|
|
396
240
|
|
|
397
241
|
| `company_id` | string | No | Company identifier |
|
|
398
242
|
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
243
|
### Pagination
|
|
405
244
|
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
245
|
| Property | Type | Required | Description |
|
|
410
|
-
|
|
246
|
+
| -------- | ---- | -------- | ----------- |
|
|
247
|
+
|
|
411
248
|
|
|
412
249
|
| `total` | integer | No | Total number of items |
|
|
413
250
|
|
|
@@ -417,13 +254,6 @@ Content-Type: `application/json`
|
|
|
417
254
|
|
|
418
255
|
| `total_pages` | integer | No | Total number of pages |
|
|
419
256
|
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
257
|
## TypeScript Usage
|
|
428
258
|
|
|
429
|
-
See [payment-terms-examples.md](./payment-terms-examples.md) for detailed TypeScript usage examples.
|
|
259
|
+
See [payment-terms-examples.md](./payment-terms-examples.md) for detailed TypeScript usage examples.
|
|
@@ -11,48 +11,41 @@ npm install repzo
|
|
|
11
11
|
## Basic Setup
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import { Service } from
|
|
14
|
+
import { Service } from "repzo";
|
|
15
15
|
|
|
16
16
|
// Initialize with your API key
|
|
17
|
-
const apiKey =
|
|
18
|
-
const baseURL =
|
|
17
|
+
const apiKey = "your-api-key";
|
|
18
|
+
const baseURL = "https://api.repzo.me/v1";
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
## API Usage Examples
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
23
|
### Find payments
|
|
26
24
|
|
|
27
|
-
|
|
28
|
-
|
|
29
25
|
```typescript
|
|
30
|
-
|
|
31
26
|
// GET /payments
|
|
32
27
|
|
|
33
28
|
const params = {
|
|
34
|
-
|
|
35
29
|
params: null, // Query parameters for filtering payments
|
|
36
|
-
|
|
37
30
|
};
|
|
38
31
|
|
|
39
|
-
const result = await fetch(
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
32
|
+
const result = await fetch(
|
|
33
|
+
`${baseURL}/payments?${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 payment
|
|
70
61
|
|
|
71
|
-
|
|
72
|
-
|
|
73
62
|
```typescript
|
|
74
|
-
|
|
75
63
|
// POST /payments
|
|
76
64
|
|
|
77
65
|
const requestBody = {
|
|
@@ -80,59 +68,46 @@ const requestBody = {
|
|
|
80
68
|
};
|
|
81
69
|
|
|
82
70
|
const result = await fetch(`${baseURL}/payments`, {
|
|
83
|
-
method:
|
|
71
|
+
method: "POST",
|
|
84
72
|
headers: {
|
|
85
|
-
|
|
86
|
-
|
|
73
|
+
Authorization: `Bearer ${apiKey}`,
|
|
74
|
+
"Content-Type": "application/json",
|
|
87
75
|
},
|
|
88
|
-
body: JSON.stringify(requestBody)
|
|
76
|
+
body: JSON.stringify(requestBody),
|
|
89
77
|
});
|
|
90
78
|
|
|
91
79
|
const data = await result.json();
|
|
92
80
|
console.log(data);
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
81
|
```
|
|
97
82
|
|
|
98
|
-
|
|
99
|
-
|
|
100
83
|
---
|
|
101
84
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
85
|
### Get a payment by ID
|
|
106
86
|
|
|
107
|
-
|
|
108
|
-
|
|
109
87
|
```typescript
|
|
110
|
-
|
|
111
88
|
// GET /payments/{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(
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
94
|
+
const result = await fetch(
|
|
95
|
+
`${baseURL}/payments/{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 payment
|
|
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,27 +136,21 @@ console.log(data);
|
|
|
165
136
|
}
|
|
166
137
|
```
|
|
167
138
|
|
|
168
|
-
|
|
169
139
|
---
|
|
170
140
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
141
|
## Using with Repzo SDK Service Types
|
|
175
142
|
|
|
176
143
|
The Repzo SDK provides TypeScript interfaces for type safety:
|
|
177
144
|
|
|
178
145
|
```typescript
|
|
179
|
-
import { Service } from
|
|
146
|
+
import { Service } from "repzo";
|
|
180
147
|
|
|
181
148
|
// Example using SDK types
|
|
182
149
|
|
|
183
|
-
|
|
184
150
|
async function example() {
|
|
185
151
|
// Use the Service.Payments types for better type safety
|
|
186
152
|
// This provides intellisense and compile-time type checking
|
|
187
153
|
}
|
|
188
|
-
|
|
189
154
|
```
|
|
190
155
|
|
|
191
156
|
## Error Handling
|
|
@@ -193,11 +158,11 @@ async function example() {
|
|
|
193
158
|
```typescript
|
|
194
159
|
try {
|
|
195
160
|
const result = await fetch(`${baseURL}/endpoint`, {
|
|
196
|
-
method:
|
|
161
|
+
method: "GET",
|
|
197
162
|
headers: {
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
}
|
|
163
|
+
Authorization: `Bearer ${apiKey}`,
|
|
164
|
+
"Content-Type": "application/json",
|
|
165
|
+
},
|
|
201
166
|
});
|
|
202
167
|
|
|
203
168
|
if (!result.ok) {
|
|
@@ -205,14 +170,14 @@ try {
|
|
|
205
170
|
}
|
|
206
171
|
|
|
207
172
|
const data = await result.json();
|
|
208
|
-
|
|
173
|
+
|
|
209
174
|
if (!data.success) {
|
|
210
|
-
throw new Error(data.error ||
|
|
175
|
+
throw new Error(data.error || "API request failed");
|
|
211
176
|
}
|
|
212
|
-
|
|
177
|
+
|
|
213
178
|
return data.data;
|
|
214
179
|
} catch (error) {
|
|
215
|
-
console.error(
|
|
180
|
+
console.error("API request failed:", error);
|
|
216
181
|
throw error;
|
|
217
182
|
}
|
|
218
183
|
```
|
|
@@ -228,18 +193,21 @@ const params = {
|
|
|
228
193
|
// other filters...
|
|
229
194
|
};
|
|
230
195
|
|
|
231
|
-
const result = await fetch(
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
196
|
+
const result = await fetch(
|
|
197
|
+
`${baseURL}/endpoint?${new URLSearchParams(params)}`,
|
|
198
|
+
{
|
|
199
|
+
method: "GET",
|
|
200
|
+
headers: {
|
|
201
|
+
Authorization: `Bearer ${apiKey}`,
|
|
202
|
+
"Content-Type": "application/json",
|
|
203
|
+
},
|
|
236
204
|
}
|
|
237
|
-
|
|
205
|
+
);
|
|
238
206
|
|
|
239
207
|
const data = await result.json();
|
|
240
208
|
|
|
241
209
|
// Access pagination info
|
|
242
|
-
console.log(
|
|
243
|
-
console.log(
|
|
244
|
-
console.log(
|
|
245
|
-
```
|
|
210
|
+
console.log("Total items:", data.paging.total);
|
|
211
|
+
console.log("Current page:", data.paging.page);
|
|
212
|
+
console.log("Total pages:", data.paging.pages);
|
|
213
|
+
```
|