repzo 1.0.141 → 1.0.142
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/README.md +16 -315
- package/docs/api/activity-ai-sales-order-examples.md +63 -112
- package/docs/api/activity-ai-sales-order.md +15 -215
- package/docs/api/activity-feedback-examples.md +82 -136
- package/docs/api/activity-feedback-v2-examples.md +86 -138
- package/docs/api/activity-feedback-v2.md +19 -263
- package/docs/api/activity-feedback.md +19 -263
- package/docs/api/activity-storecheck-examples.md +62 -101
- package/docs/api/activity-storecheck.md +13 -186
- package/docs/api/adjust-account-examples.md +50 -78
- package/docs/api/adjust-account.md +12 -117
- package/docs/api/adjust-inventory-examples.md +50 -78
- package/docs/api/adjust-inventory.md +16 -121
- package/docs/api/approval-request-examples.md +58 -97
- package/docs/api/approval-request.md +26 -189
- package/docs/api/approvals-examples.md +58 -97
- package/docs/api/approvals.md +26 -189
- package/docs/api/asset-examples.md +53 -95
- package/docs/api/asset-part-examples.md +62 -101
- package/docs/api/asset-part-receival-examples.md +62 -101
- package/docs/api/asset-part-receival.md +13 -186
- package/docs/api/asset-part-transfer-examples.md +63 -112
- package/docs/api/asset-part-transfer.md +15 -215
- package/docs/api/asset-part-type-examples.md +62 -101
- package/docs/api/asset-part-type.md +13 -186
- package/docs/api/asset-part-unit-examples.md +62 -101
- package/docs/api/asset-part-unit.md +13 -186
- package/docs/api/asset-part.md +13 -186
- package/docs/api/asset-type-examples.md +58 -97
- package/docs/api/asset-type.md +26 -189
- package/docs/api/asset-unit-examples.md +80 -147
- package/docs/api/asset-unit.md +19 -306
- package/docs/api/asset.md +26 -189
- package/docs/api/banks-examples.md +53 -95
- package/docs/api/banks.md +26 -189
- package/docs/api/bankslists-examples.md +58 -97
- package/docs/api/bankslists.md +26 -189
- package/docs/api/brand-examples.md +58 -97
- package/docs/api/brand.md +18 -181
- package/docs/api/category-examples.md +58 -97
- package/docs/api/category.md +18 -181
- package/docs/api/checks-examples.md +45 -76
- package/docs/api/checks.md +12 -117
- package/docs/api/client-channel-examples.md +62 -101
- package/docs/api/client-channel.md +20 -207
- package/docs/api/client-contact-examples.md +62 -101
- package/docs/api/client-contact.md +25 -233
- package/docs/api/client-examples.md +53 -95
- package/docs/api/client-location-examples.md +71 -126
- package/docs/api/client-location.md +19 -275
- package/docs/api/client.md +18 -181
- package/docs/api/contract-examples.md +58 -97
- package/docs/api/contract-installment-examples.md +84 -148
- package/docs/api/contract-installment.md +21 -303
- package/docs/api/contract.md +26 -189
- package/docs/api/custom-list-examples.md +58 -97
- package/docs/api/custom-list-item-examples.md +58 -97
- package/docs/api/custom-list-item.md +26 -189
- package/docs/api/custom-list.md +26 -189
- package/docs/api/custom-status-examples.md +58 -97
- package/docs/api/custom-status.md +26 -189
- package/docs/api/day-examples.md +45 -76
- package/docs/api/day.md +12 -117
- package/docs/api/feedback-options-examples.md +90 -153
- package/docs/api/feedback-options.md +23 -307
- package/docs/api/fullinvoices-examples.md +51 -83
- package/docs/api/fullinvoices.md +22 -162
- package/docs/api/index.md +99 -705
- package/docs/api/integration-action-log-examples.md +62 -101
- package/docs/api/integration-action-log.md +13 -186
- package/docs/api/integration-app-examples.md +51 -83
- package/docs/api/integration-app.md +16 -156
- package/docs/api/integration-command-log-examples.md +62 -101
- package/docs/api/integration-command-log.md +13 -186
- package/docs/api/inventory-adjustment-reason-examples.md +58 -97
- package/docs/api/inventory-adjustment-reason.md +26 -189
- package/docs/api/inventory-examples.md +35 -45
- package/docs/api/inventory.md +8 -53
- package/docs/api/mail-unsubscribe-examples.md +69 -124
- package/docs/api/mail-unsubscribe.md +13 -251
- package/docs/api/measureunit-examples.md +58 -97
- package/docs/api/measureunit-family-examples.md +58 -97
- package/docs/api/measureunit-family.md +18 -188
- package/docs/api/measureunit.md +20 -190
- package/docs/api/media-examples.md +53 -95
- package/docs/api/media-storage-examples.md +58 -97
- package/docs/api/media-storage.md +18 -181
- package/docs/api/media.md +18 -181
- package/docs/api/msl-examples.md +53 -95
- package/docs/api/msl-products-examples.md +58 -97
- package/docs/api/msl-products.md +26 -189
- package/docs/api/msl.md +26 -189
- package/docs/api/ocr-invoice-job-examples.md +74 -132
- package/docs/api/ocr-invoice-job-group-examples.md +73 -121
- package/docs/api/ocr-invoice-job-group.md +15 -215
- package/docs/api/ocr-invoice-job-page-examples.md +63 -112
- package/docs/api/ocr-invoice-job-page.md +15 -215
- package/docs/api/ocr-invoice-job-template-examples.md +62 -101
- package/docs/api/ocr-invoice-job-template.md +13 -186
- package/docs/api/ocr-invoice-job.md +19 -253
- package/docs/api/patch-action-examples.md +63 -112
- package/docs/api/patch-action.md +15 -215
- package/docs/api/payment-terms-examples.md +58 -97
- package/docs/api/payment-terms.md +28 -198
- package/docs/api/payments-examples.md +51 -83
- package/docs/api/payments.md +22 -162
- package/docs/api/pricelist-examples.md +58 -97
- package/docs/api/pricelist-item-examples.md +58 -97
- package/docs/api/pricelist-item.md +24 -208
- package/docs/api/pricelist.md +18 -181
- package/docs/api/product-examples.md +58 -97
- package/docs/api/product-group-examples.md +58 -97
- package/docs/api/product-group.md +18 -181
- package/docs/api/product-modifiers-group-examples.md +70 -125
- package/docs/api/product-modifiers-group.md +19 -275
- package/docs/api/product.md +20 -190
- package/docs/api/proforma-examples.md +51 -83
- package/docs/api/proforma.md +22 -162
- package/docs/api/quick-convert-to-pdf-examples.md +30 -41
- package/docs/api/quick-convert-to-pdf.md +6 -56
- package/docs/api/receiving-material-examples.md +51 -83
- package/docs/api/receiving-material.md +16 -156
- package/docs/api/refund-examples.md +46 -81
- package/docs/api/refund.md +16 -156
- package/docs/api/rep-balance-summary-examples.md +36 -46
- package/docs/api/rep-balance-summary.md +6 -53
- package/docs/api/rep-examples.md +53 -95
- package/docs/api/rep.md +18 -181
- package/docs/api/return-asset-part-unit-examples.md +62 -101
- package/docs/api/return-asset-part-unit.md +13 -186
- package/docs/api/return-reason-examples.md +58 -97
- package/docs/api/return-reason.md +18 -181
- package/docs/api/route-examples.md +53 -95
- package/docs/api/route.md +18 -181
- package/docs/api/safe-invoice-serial-counter-examples.md +72 -127
- package/docs/api/safe-invoice-serial-counter.md +17 -266
- package/docs/api/settings-examples.md +47 -70
- package/docs/api/settings.md +18 -123
- package/docs/api/settlement-examples.md +50 -78
- package/docs/api/settlement.md +12 -117
- package/docs/api/speciality-examples.md +70 -125
- package/docs/api/speciality.md +17 -266
- package/docs/api/store-asset-part-unit-examples.md +62 -101
- package/docs/api/store-asset-part-unit.md +13 -186
- package/docs/api/storecheck-template-examples.md +58 -97
- package/docs/api/storecheck-template.md +18 -181
- package/docs/api/subcategory-examples.md +58 -97
- package/docs/api/subcategory.md +18 -181
- package/docs/api/supplier-examples.md +58 -97
- package/docs/api/supplier.md +26 -189
- package/docs/api/svix-integration-examples.md +62 -101
- package/docs/api/svix-integration.md +13 -186
- package/docs/api/tag-examples.md +53 -95
- package/docs/api/tag.md +18 -181
- package/docs/api/tax-examples.md +53 -95
- package/docs/api/tax.md +18 -181
- package/docs/api/team-examples.md +53 -95
- package/docs/api/team.md +18 -181
- package/docs/api/transfer-examples.md +51 -83
- package/docs/api/transfer.md +16 -156
- package/docs/api/update-integration-meta-examples.md +63 -112
- package/docs/api/update-integration-meta.md +15 -215
- package/docs/api/variant-examples.md +58 -97
- package/docs/api/variant.md +20 -183
- package/docs/api/visit-examples.md +46 -81
- package/docs/api/visit.md +22 -162
- package/docs/api/warehouse-examples.md +58 -97
- package/docs/api/warehouse.md +18 -181
- package/docs/api/workorder-category-examples.md +76 -141
- package/docs/api/workorder-category.md +19 -305
- package/docs/api/workorder-examples.md +58 -97
- package/docs/api/workorder-portal-examples.md +75 -132
- package/docs/api/workorder-portal-link-examples.md +70 -145
- package/docs/api/workorder-portal-link.md +23 -336
- package/docs/api/workorder-portal.md +19 -271
- package/docs/api/workorder-request-examples.md +58 -97
- package/docs/api/workorder-request.md +26 -189
- package/docs/api/workorder.md +26 -189
- package/docs/generated/index.html +1 -1
- package/docs/generated/repzo-api-complete.yaml +2585 -2585
- package/lib/index.d.ts +180 -0
- package/lib/index.js +90 -0
- package/lib/types/index.d.ts +13393 -14636
- package/package.json +2 -3
- package/src/types/index.ts +14 -1
|
@@ -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 settings
|
|
26
24
|
|
|
27
|
-
|
|
28
|
-
|
|
29
25
|
```typescript
|
|
30
|
-
|
|
31
26
|
// GET /settings
|
|
32
27
|
|
|
33
28
|
const params = {
|
|
34
|
-
|
|
35
29
|
params: null, // Query parameters for filtering settings
|
|
36
|
-
|
|
37
30
|
};
|
|
38
31
|
|
|
39
|
-
const result = await fetch(
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
32
|
+
const result = await fetch(
|
|
33
|
+
`${baseURL}/settings?${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,43 +55,34 @@ console.log(data);
|
|
|
62
55
|
}
|
|
63
56
|
```
|
|
64
57
|
|
|
65
|
-
|
|
66
58
|
---
|
|
67
59
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
60
|
### Get settings by ID
|
|
72
61
|
|
|
73
|
-
|
|
74
|
-
|
|
75
62
|
```typescript
|
|
76
|
-
|
|
77
63
|
// GET /settings/{id}
|
|
78
64
|
|
|
79
65
|
const params = {
|
|
80
|
-
|
|
81
|
-
id: 'example-value', // No description
|
|
82
|
-
|
|
66
|
+
id: "example-value", // No description
|
|
83
67
|
};
|
|
84
68
|
|
|
85
|
-
const result = await fetch(
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
69
|
+
const result = await fetch(
|
|
70
|
+
`${baseURL}/settings/{id}?${new URLSearchParams(params)}`,
|
|
71
|
+
{
|
|
72
|
+
method: "GET",
|
|
73
|
+
headers: {
|
|
74
|
+
Authorization: `Bearer ${apiKey}`,
|
|
75
|
+
"Content-Type": "application/json",
|
|
76
|
+
},
|
|
90
77
|
}
|
|
91
|
-
|
|
78
|
+
);
|
|
92
79
|
|
|
93
80
|
const data = await result.json();
|
|
94
81
|
console.log(data);
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
82
|
```
|
|
99
83
|
|
|
100
|
-
|
|
101
84
|
**Expected Response:**
|
|
85
|
+
|
|
102
86
|
```json
|
|
103
87
|
{
|
|
104
88
|
"success": true,
|
|
@@ -108,20 +92,16 @@ console.log(data);
|
|
|
108
92
|
}
|
|
109
93
|
```
|
|
110
94
|
|
|
111
|
-
|
|
112
95
|
---
|
|
113
96
|
|
|
114
|
-
|
|
115
97
|
### Update settings
|
|
116
98
|
|
|
117
|
-
|
|
118
|
-
|
|
119
99
|
```typescript
|
|
120
100
|
|
|
121
101
|
```
|
|
122
102
|
|
|
123
|
-
|
|
124
103
|
**Expected Response:**
|
|
104
|
+
|
|
125
105
|
```json
|
|
126
106
|
{
|
|
127
107
|
"success": true,
|
|
@@ -131,27 +111,21 @@ console.log(data);
|
|
|
131
111
|
}
|
|
132
112
|
```
|
|
133
113
|
|
|
134
|
-
|
|
135
114
|
---
|
|
136
115
|
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
116
|
## Using with Repzo SDK Service Types
|
|
141
117
|
|
|
142
118
|
The Repzo SDK provides TypeScript interfaces for type safety:
|
|
143
119
|
|
|
144
120
|
```typescript
|
|
145
|
-
import { Service } from
|
|
121
|
+
import { Service } from "repzo";
|
|
146
122
|
|
|
147
123
|
// Example using SDK types
|
|
148
124
|
|
|
149
|
-
|
|
150
125
|
async function example() {
|
|
151
126
|
// Use the Service.Settings types for better type safety
|
|
152
127
|
// This provides intellisense and compile-time type checking
|
|
153
128
|
}
|
|
154
|
-
|
|
155
129
|
```
|
|
156
130
|
|
|
157
131
|
## Error Handling
|
|
@@ -159,11 +133,11 @@ async function example() {
|
|
|
159
133
|
```typescript
|
|
160
134
|
try {
|
|
161
135
|
const result = await fetch(`${baseURL}/endpoint`, {
|
|
162
|
-
method:
|
|
136
|
+
method: "GET",
|
|
163
137
|
headers: {
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
}
|
|
138
|
+
Authorization: `Bearer ${apiKey}`,
|
|
139
|
+
"Content-Type": "application/json",
|
|
140
|
+
},
|
|
167
141
|
});
|
|
168
142
|
|
|
169
143
|
if (!result.ok) {
|
|
@@ -171,14 +145,14 @@ try {
|
|
|
171
145
|
}
|
|
172
146
|
|
|
173
147
|
const data = await result.json();
|
|
174
|
-
|
|
148
|
+
|
|
175
149
|
if (!data.success) {
|
|
176
|
-
throw new Error(data.error ||
|
|
150
|
+
throw new Error(data.error || "API request failed");
|
|
177
151
|
}
|
|
178
|
-
|
|
152
|
+
|
|
179
153
|
return data.data;
|
|
180
154
|
} catch (error) {
|
|
181
|
-
console.error(
|
|
155
|
+
console.error("API request failed:", error);
|
|
182
156
|
throw error;
|
|
183
157
|
}
|
|
184
158
|
```
|
|
@@ -194,18 +168,21 @@ const params = {
|
|
|
194
168
|
// other filters...
|
|
195
169
|
};
|
|
196
170
|
|
|
197
|
-
const result = await fetch(
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
171
|
+
const result = await fetch(
|
|
172
|
+
`${baseURL}/endpoint?${new URLSearchParams(params)}`,
|
|
173
|
+
{
|
|
174
|
+
method: "GET",
|
|
175
|
+
headers: {
|
|
176
|
+
Authorization: `Bearer ${apiKey}`,
|
|
177
|
+
"Content-Type": "application/json",
|
|
178
|
+
},
|
|
202
179
|
}
|
|
203
|
-
|
|
180
|
+
);
|
|
204
181
|
|
|
205
182
|
const data = await result.json();
|
|
206
183
|
|
|
207
184
|
// Access pagination info
|
|
208
|
-
console.log(
|
|
209
|
-
console.log(
|
|
210
|
-
console.log(
|
|
211
|
-
```
|
|
185
|
+
console.log("Total items:", data.paging.total);
|
|
186
|
+
console.log("Current page:", data.paging.page);
|
|
187
|
+
console.log("Total pages:", data.paging.pages);
|
|
188
|
+
```
|
package/docs/api/settings.md
CHANGED
|
@@ -6,195 +6,111 @@ OpenAPI specification for Repzo Settings 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
|
### `/settings`
|
|
28
20
|
|
|
29
|
-
|
|
30
21
|
#### GET /settings
|
|
31
22
|
|
|
32
23
|
**Summary:** Find settings
|
|
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 settings |
|
|
45
|
-
|
|
46
|
-
|
|
28
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
47
29
|
|
|
48
30
|
|
|
31
|
+
| `params` | query | object | No | Query parameters for filtering settings |
|
|
49
32
|
|
|
50
33
|
##### Responses
|
|
51
34
|
|
|
52
|
-
|
|
53
35
|
**200** - A list of settings
|
|
54
36
|
|
|
55
|
-
|
|
56
|
-
|
|
57
37
|
Content-Type: `application/json`
|
|
58
38
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
39
|
---
|
|
64
40
|
|
|
65
|
-
|
|
66
|
-
|
|
67
41
|
### `/settings/{id}`
|
|
68
42
|
|
|
69
|
-
|
|
70
43
|
#### GET /settings/{id}
|
|
71
44
|
|
|
72
45
|
**Summary:** Get settings by ID
|
|
73
46
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
47
|
##### Parameters
|
|
80
48
|
|
|
81
49
|
| Name | Location | Type | Required | Description |
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
| `id` | path | string | Yes | No description |
|
|
85
|
-
|
|
86
|
-
|
|
50
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
87
51
|
|
|
88
52
|
|
|
53
|
+
| `id` | path | string | Yes | No description |
|
|
89
54
|
|
|
90
55
|
##### Responses
|
|
91
56
|
|
|
92
|
-
|
|
93
57
|
**200** - Settings details
|
|
94
58
|
|
|
95
|
-
|
|
96
|
-
|
|
97
59
|
Content-Type: `application/json`
|
|
98
60
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
61
|
---
|
|
104
62
|
|
|
105
|
-
|
|
106
63
|
#### PUT /settings/{id}
|
|
107
64
|
|
|
108
65
|
**Summary:** Update settings
|
|
109
66
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
67
|
##### Parameters
|
|
116
68
|
|
|
117
69
|
| Name | Location | Type | Required | Description |
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
| `id` | path | string | Yes | No description |
|
|
121
|
-
|
|
70
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
122
71
|
|
|
123
72
|
|
|
73
|
+
| `id` | path | string | Yes | No description |
|
|
124
74
|
|
|
125
75
|
##### Request Body
|
|
126
76
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
77
|
**Content Types:**
|
|
131
78
|
|
|
132
79
|
- `application/json`
|
|
133
80
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
81
|
##### Responses
|
|
138
82
|
|
|
139
|
-
|
|
140
83
|
**200** - Settings updated
|
|
141
84
|
|
|
142
|
-
|
|
143
|
-
|
|
144
85
|
Content-Type: `application/json`
|
|
145
86
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
87
|
---
|
|
151
88
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
89
|
## Data Models
|
|
156
90
|
|
|
157
|
-
|
|
158
|
-
|
|
159
91
|
### SettingsFindResult
|
|
160
92
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
93
|
| Property | Type | Required | Description |
|
|
165
|
-
|
|
94
|
+
| -------- | ---- | -------- | ----------- |
|
|
95
|
+
|
|
166
96
|
|
|
167
97
|
| `data` | array | No | No description |
|
|
168
98
|
|
|
169
99
|
| `meta` | object | No | No description |
|
|
170
100
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
101
|
### SettingsGetResult
|
|
177
102
|
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
103
|
| Property | Type | Required | Description |
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
| `data` | object | No | No description |
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
104
|
+
| -------- | ---- | -------- | ----------- |
|
|
188
105
|
|
|
189
106
|
|
|
107
|
+
| `data` | object | No | No description |
|
|
190
108
|
|
|
191
109
|
### SettingsUpdateBody
|
|
192
110
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
111
|
| Property | Type | Required | Description |
|
|
197
|
-
|
|
112
|
+
| -------- | ---- | -------- | ----------- |
|
|
113
|
+
|
|
198
114
|
|
|
199
115
|
| `key` | string | No | No description |
|
|
200
116
|
|
|
@@ -204,33 +120,19 @@ Content-Type: `application/json`
|
|
|
204
120
|
|
|
205
121
|
| `description` | string | No | No description |
|
|
206
122
|
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
123
|
### SettingsUpdateResult
|
|
213
124
|
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
125
|
| Property | Type | Required | Description |
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
| `data` | object | No | No description |
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
126
|
+
| -------- | ---- | -------- | ----------- |
|
|
224
127
|
|
|
225
128
|
|
|
129
|
+
| `data` | object | No | No description |
|
|
226
130
|
|
|
227
131
|
### Settings
|
|
228
132
|
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
133
|
| Property | Type | Required | Description |
|
|
233
|
-
|
|
134
|
+
| -------- | ---- | -------- | ----------- |
|
|
135
|
+
|
|
234
136
|
|
|
235
137
|
| `_id` | string | No | No description |
|
|
236
138
|
|
|
@@ -246,13 +148,6 @@ Content-Type: `application/json`
|
|
|
246
148
|
|
|
247
149
|
| `updatedAt` | string | No | No description |
|
|
248
150
|
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
151
|
## TypeScript Usage
|
|
257
152
|
|
|
258
|
-
See [settings-examples.md](./settings-examples.md) for detailed TypeScript usage examples.
|
|
153
|
+
See [settings-examples.md](./settings-examples.md) for detailed TypeScript usage examples.
|