@caraer/client 2.0.437 → 2.0.441
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/.openapi-generator/FILES +87 -2
- package/api.ts +1952 -755
- package/dist/api.d.ts +2039 -713
- package/dist/api.js +471 -465
- package/dist/esm/api.d.ts +2039 -713
- package/dist/esm/api.js +468 -462
- package/docs/AppBarIframeSessionsApi.md +10 -4
- package/docs/AppBarsApi.md +11 -4
- package/docs/AppInstallationRuntimeApi.md +58 -0
- package/docs/ApplicationsApi.md +128 -58
- package/docs/AutomationsApi.md +6 -4
- package/docs/BillingApi.md +10 -4
- package/docs/CRUD.md +24 -0
- package/docs/CompanyApi.md +44 -18
- package/docs/CreateResponseFeedDTO.md +23 -0
- package/docs/CreateResponseMapStringString.md +23 -0
- package/docs/DeleteResponseFeedDTO.md +23 -0
- package/docs/DeveloperProjectsApi.md +31 -6
- package/docs/DeveloperSandboxDTO.md +43 -0
- package/docs/DeveloperSandboxesApi.md +12 -2
- package/docs/ErrorResponse.md +3 -3
- package/docs/ExistingWidgetSummary.md +4 -4
- package/docs/FeedsApi.md +11 -6
- package/docs/FileManagementApi.md +19 -9
- package/docs/FilterApi.md +21 -8
- package/docs/FlowPaginationRequest.md +43 -0
- package/docs/FormsApi.md +95 -56
- package/docs/ModuleApi.md +61 -38
- package/docs/NotificationsApi.md +15 -2
- package/docs/ObjectsApi.md +80 -39
- package/docs/PaginationRequest.md +31 -0
- package/docs/PaginationResponseAppDTO.md +31 -0
- package/docs/PaginationResponseCaraerObjectDTO.md +31 -0
- package/docs/PaginationResponseCompanyDTO.md +31 -0
- package/docs/{PaginationResponse.md → PaginationResponseFeedDTO.md} +4 -4
- package/docs/PaginationResponseFormDTO.md +31 -0
- package/docs/PaginationResponseMapStringObject.md +31 -0
- package/docs/PaginationResponseObject.md +31 -0
- package/docs/PaginationResponsePageContentDTO.md +31 -0
- package/docs/PaginationResponsePropertyCalculationTypeDTO.md +31 -0
- package/docs/PaginationResponsePropertyDTO.md +31 -0
- package/docs/PaginationResponsePropertyFormat.md +31 -0
- package/docs/PaginationResponsePropertyOption.md +31 -0
- package/docs/PaginationResponsePublicEnvironmentDTO.md +31 -0
- package/docs/PaginationResponsePublicFormDTO.md +31 -0
- package/docs/PaginationResponseRelationDTO.md +31 -0
- package/docs/PaginationResponseSavedFilterDTO.md +31 -0
- package/docs/PaginationResponseServerlessFunctionDTO.md +31 -0
- package/docs/PaginationResponseSubscribeWebhookDTO.md +31 -0
- package/docs/PaginationResponseSyncDTO.md +31 -0
- package/docs/PaginationResponseTraitDTO.md +31 -0
- package/docs/PaginationResponseViewDTO.md +31 -0
- package/docs/PaginationResponseWebMenuDTO.md +31 -0
- package/docs/ProjectBuildDTO.md +55 -0
- package/docs/ProjectDeployDTO.md +53 -0
- package/docs/PropertyApi.md +84 -47
- package/docs/PublicFormDTO.md +55 -0
- package/docs/RecordPaginationRequest.md +37 -0
- package/docs/RecordsApi.md +141 -60
- package/docs/RelationsApi.md +82 -48
- package/docs/SearchRequest.md +29 -0
- package/docs/ServerlessFunctionsApi.md +42 -16
- package/docs/ShowResponse.md +3 -3
- package/docs/ShowResponseAnalyticsDashboardConfig.md +23 -0
- package/docs/ShowResponseAppBarIframeSessionContextDTO.md +23 -0
- package/docs/ShowResponseAppBarIframeSessionTokenDTO.md +23 -0
- package/docs/ShowResponseAppDTO.md +23 -0
- package/docs/ShowResponseBillingStatusDTO.md +23 -0
- package/docs/ShowResponseCaraerObjectDTO.md +23 -0
- package/docs/ShowResponseCompanyDTO.md +23 -0
- package/docs/ShowResponseDeveloperProjectDTO.md +23 -0
- package/docs/ShowResponseDigitalIdentityDTO.md +23 -0
- package/docs/ShowResponseFeedDTO.md +23 -0
- package/docs/ShowResponseFormDTO.md +23 -0
- package/docs/ShowResponseListEnvironmentDTO.md +23 -0
- package/docs/ShowResponseListFormObjectSummaryDTO.md +23 -0
- package/docs/ShowResponseListInstalledAppBarDTO.md +23 -0
- package/docs/ShowResponseListPropertyDTO.md +23 -0
- package/docs/ShowResponseListWebpagePickerItemDTO.md +23 -0
- package/docs/ShowResponseLoadAppSettingOptionsResponse.md +23 -0
- package/docs/ShowResponseMapStringAnalyticsDashboardConfig.md +23 -0
- package/docs/ShowResponseMapStringBoolean.md +23 -0
- package/docs/ShowResponseMapStringString.md +23 -0
- package/docs/ShowResponsePageContentDTO.md +23 -0
- package/docs/ShowResponsePreviewDTO.md +23 -0
- package/docs/ShowResponsePropertyDTO.md +23 -0
- package/docs/ShowResponsePublicFormDTO.md +23 -0
- package/docs/ShowResponseRelationDTO.md +23 -0
- package/docs/ShowResponseSavedFilterDTO.md +23 -0
- package/docs/ShowResponseServerlessFunctionDTO.md +23 -0
- package/docs/ShowResponseString.md +23 -0
- package/docs/ShowResponseSubscribeWebhookDTO.md +23 -0
- package/docs/ShowResponseTemplateWebpageDTO.md +23 -0
- package/docs/ShowResponseTraitDTO.md +23 -0
- package/docs/ShowResponseViewDTO.md +23 -0
- package/docs/ShowResponseWebMenuDTO.md +23 -0
- package/docs/ShowResponseWebsiteSettingsDTO.md +23 -0
- package/docs/SuccessResponseAggregateResponse.md +23 -0
- package/docs/SuccessResponseCollectionRelation.md +23 -0
- package/docs/SuccessResponseCompanyDTO.md +23 -0
- package/docs/{SuccessResponse.md → SuccessResponseFeedDTO.md} +4 -4
- package/docs/SuccessResponseFlow.md +23 -0
- package/docs/SuccessResponseListAggregateResponse.md +23 -0
- package/docs/SuccessResponseListCaraerObjectDTO.md +23 -0
- package/docs/SuccessResponseListDeveloperSandboxDTO.md +23 -0
- package/docs/SuccessResponseListMapStringObject.md +23 -0
- package/docs/SuccessResponseListProjectBuildDTO.md +23 -0
- package/docs/SuccessResponseListProjectDeployDTO.md +23 -0
- package/docs/SuccessResponseListPropertyDTO.md +23 -0
- package/docs/SuccessResponseListString.md +23 -0
- package/docs/SuccessResponseMapStringInteger.md +23 -0
- package/docs/SuccessResponseMapStringObject.md +23 -0
- package/docs/SuccessResponseObject.md +23 -0
- package/docs/SuccessResponseSuggestAnalyticsWidgetsResponse.md +23 -0
- package/docs/SuccessResponseTable.md +23 -0
- package/docs/SyncApi.md +27 -9
- package/docs/TraitsApi.md +41 -23
- package/docs/UpdateResponseFeedDTO.md +23 -0
- package/docs/ViewsApi.md +44 -26
- package/docs/WebMenusApi.md +30 -12
- package/docs/WebpagesApi.md +128 -24
- package/package.json +1 -1
package/docs/SyncApi.md
CHANGED
|
@@ -62,6 +62,9 @@ const { status, data } = await apiInstance.createSync(
|
|
|
62
62
|
|**200** | Sync created successfully | - |
|
|
63
63
|
|**400** | Invalid sync data | - |
|
|
64
64
|
|**500** | Internal server error | - |
|
|
65
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
66
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
67
|
+
|**404** | The requested resource was not found. | - |
|
|
65
68
|
|
|
66
69
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
67
70
|
|
|
@@ -119,6 +122,9 @@ const { status, data } = await apiInstance.deleteSync(
|
|
|
119
122
|
|**200** | Sync deleted successfully | - |
|
|
120
123
|
|**400** | Invalid sync data | - |
|
|
121
124
|
|**500** | Internal server error | - |
|
|
125
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
126
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
127
|
+
|**404** | The requested resource was not found. | - |
|
|
122
128
|
|
|
123
129
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
124
130
|
|
|
@@ -176,11 +182,14 @@ const { status, data } = await apiInstance.getSync(
|
|
|
176
182
|
|**200** | Sync fetched successfully | - |
|
|
177
183
|
|**400** | Invalid sync data | - |
|
|
178
184
|
|**500** | Internal server error | - |
|
|
185
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
186
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
187
|
+
|**404** | The requested resource was not found. | - |
|
|
179
188
|
|
|
180
189
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
181
190
|
|
|
182
191
|
# **getSyncs**
|
|
183
|
-
>
|
|
192
|
+
> PaginationResponseSyncDTO getSyncs(paginationRequest)
|
|
184
193
|
|
|
185
194
|
Retrieves a paginated list of syncs. Returns a PaginationResponse containing SyncDTO objects based on the provided pagination criteria.
|
|
186
195
|
|
|
@@ -189,16 +198,17 @@ Retrieves a paginated list of syncs. Returns a PaginationResponse containing Syn
|
|
|
189
198
|
```typescript
|
|
190
199
|
import {
|
|
191
200
|
SyncApi,
|
|
192
|
-
Configuration
|
|
201
|
+
Configuration,
|
|
202
|
+
PaginationRequest
|
|
193
203
|
} from '@caraer/client';
|
|
194
204
|
|
|
195
205
|
const configuration = new Configuration();
|
|
196
206
|
const apiInstance = new SyncApi(configuration);
|
|
197
207
|
|
|
198
|
-
let
|
|
208
|
+
let paginationRequest: PaginationRequest; //Pagination request for syncs
|
|
199
209
|
|
|
200
210
|
const { status, data } = await apiInstance.getSyncs(
|
|
201
|
-
|
|
211
|
+
paginationRequest
|
|
202
212
|
);
|
|
203
213
|
```
|
|
204
214
|
|
|
@@ -206,12 +216,12 @@ const { status, data } = await apiInstance.getSyncs(
|
|
|
206
216
|
|
|
207
217
|
|Name | Type | Description | Notes|
|
|
208
218
|
|------------- | ------------- | ------------- | -------------|
|
|
209
|
-
| **
|
|
219
|
+
| **paginationRequest** | **PaginationRequest**| Pagination request for syncs | |
|
|
210
220
|
|
|
211
221
|
|
|
212
222
|
### Return type
|
|
213
223
|
|
|
214
|
-
**
|
|
224
|
+
**PaginationResponseSyncDTO**
|
|
215
225
|
|
|
216
226
|
### Authorization
|
|
217
227
|
|
|
@@ -229,6 +239,9 @@ const { status, data } = await apiInstance.getSyncs(
|
|
|
229
239
|
|**200** | Syncs fetched successfully | - |
|
|
230
240
|
|**400** | Invalid pagination request | - |
|
|
231
241
|
|**500** | Internal server error | - |
|
|
242
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
243
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
244
|
+
|**404** | The requested resource was not found. | - |
|
|
232
245
|
|
|
233
246
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
234
247
|
|
|
@@ -273,15 +286,17 @@ const { status, data } = await apiInstance.restoreSync(
|
|
|
273
286
|
### HTTP request headers
|
|
274
287
|
|
|
275
288
|
- **Content-Type**: Not defined
|
|
276
|
-
- **Accept**: application/json
|
|
289
|
+
- **Accept**: application/json
|
|
277
290
|
|
|
278
291
|
|
|
279
292
|
### HTTP response details
|
|
280
293
|
| Status code | Description | Response headers |
|
|
281
294
|
|-------------|-------------|------------------|
|
|
282
295
|
|**200** | Sync restored successfully | - |
|
|
283
|
-
|**404** |
|
|
284
|
-
|**500** |
|
|
296
|
+
|**404** | The requested resource was not found. | - |
|
|
297
|
+
|**500** | An internal server error occurred. | - |
|
|
298
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
299
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
285
300
|
|
|
286
301
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
287
302
|
|
|
@@ -339,6 +354,9 @@ const { status, data } = await apiInstance.updateSync(
|
|
|
339
354
|
|**200** | Sync updated successfully | - |
|
|
340
355
|
|**400** | Invalid sync data | - |
|
|
341
356
|
|**500** | Internal server error | - |
|
|
357
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
358
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
359
|
+
|**404** | The requested resource was not found. | - |
|
|
342
360
|
|
|
343
361
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
344
362
|
|
package/docs/TraitsApi.md
CHANGED
|
@@ -31,7 +31,7 @@ const apiInstance = new TraitsApi(configuration);
|
|
|
31
31
|
|
|
32
32
|
let objectUuid: string; // (default to undefined)
|
|
33
33
|
let traitName: string; // (default to undefined)
|
|
34
|
-
let body:
|
|
34
|
+
let body: object; //Trait details as a JSON map
|
|
35
35
|
|
|
36
36
|
const { status, data } = await apiInstance.createTrait(
|
|
37
37
|
objectUuid,
|
|
@@ -44,7 +44,7 @@ const { status, data } = await apiInstance.createTrait(
|
|
|
44
44
|
|
|
45
45
|
|Name | Type | Description | Notes|
|
|
46
46
|
|------------- | ------------- | ------------- | -------------|
|
|
47
|
-
| **body** | **
|
|
47
|
+
| **body** | **object**| Trait details as a JSON map | |
|
|
48
48
|
| **objectUuid** | [**string**] | | defaults to undefined|
|
|
49
49
|
| **traitName** | [**string**] | | defaults to undefined|
|
|
50
50
|
|
|
@@ -68,8 +68,10 @@ const { status, data } = await apiInstance.createTrait(
|
|
|
68
68
|
|-------------|-------------|------------------|
|
|
69
69
|
|**201** | Trait created successfully | - |
|
|
70
70
|
|**400** | Invalid input data | - |
|
|
71
|
-
|**404** |
|
|
72
|
-
|**500** |
|
|
71
|
+
|**404** | The requested resource was not found. | - |
|
|
72
|
+
|**500** | An internal server error occurred. | - |
|
|
73
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
74
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
73
75
|
|
|
74
76
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
75
77
|
|
|
@@ -117,20 +119,22 @@ const { status, data } = await apiInstance.deleteTrait(
|
|
|
117
119
|
### HTTP request headers
|
|
118
120
|
|
|
119
121
|
- **Content-Type**: Not defined
|
|
120
|
-
- **Accept**: application/json
|
|
122
|
+
- **Accept**: application/json
|
|
121
123
|
|
|
122
124
|
|
|
123
125
|
### HTTP response details
|
|
124
126
|
| Status code | Description | Response headers |
|
|
125
127
|
|-------------|-------------|------------------|
|
|
126
128
|
|**200** | Trait removed successfully | - |
|
|
127
|
-
|**404** |
|
|
128
|
-
|**500** |
|
|
129
|
+
|**404** | The requested resource was not found. | - |
|
|
130
|
+
|**500** | An internal server error occurred. | - |
|
|
131
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
132
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
129
133
|
|
|
130
134
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
131
135
|
|
|
132
136
|
# **getTrait**
|
|
133
|
-
>
|
|
137
|
+
> ShowResponseTraitDTO getTrait()
|
|
134
138
|
|
|
135
139
|
Retrieves details of a specific trait associated with the specified object, identified by the trait name. Returns a ShowResponse containing the TraitDTO. If the trait is not found, a NotFoundError is thrown.
|
|
136
140
|
|
|
@@ -164,7 +168,7 @@ const { status, data } = await apiInstance.getTrait(
|
|
|
164
168
|
|
|
165
169
|
### Return type
|
|
166
170
|
|
|
167
|
-
**
|
|
171
|
+
**ShowResponseTraitDTO**
|
|
168
172
|
|
|
169
173
|
### Authorization
|
|
170
174
|
|
|
@@ -173,20 +177,22 @@ const { status, data } = await apiInstance.getTrait(
|
|
|
173
177
|
### HTTP request headers
|
|
174
178
|
|
|
175
179
|
- **Content-Type**: Not defined
|
|
176
|
-
- **Accept**: application/json
|
|
180
|
+
- **Accept**: application/json
|
|
177
181
|
|
|
178
182
|
|
|
179
183
|
### HTTP response details
|
|
180
184
|
| Status code | Description | Response headers |
|
|
181
185
|
|-------------|-------------|------------------|
|
|
182
186
|
|**200** | Trait retrieved successfully | - |
|
|
183
|
-
|**404** |
|
|
184
|
-
|**500** |
|
|
187
|
+
|**404** | The requested resource was not found. | - |
|
|
188
|
+
|**500** | An internal server error occurred. | - |
|
|
189
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
190
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
185
191
|
|
|
186
192
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
187
193
|
|
|
188
194
|
# **getTraits**
|
|
189
|
-
>
|
|
195
|
+
> PaginationResponseTraitDTO getTraits()
|
|
190
196
|
|
|
191
197
|
Retrieves a list of traits associated with the specified object. Returns a paginated response containing TraitDTO objects. The page is set to 0 by default, with a maximum limit of 100.
|
|
192
198
|
|
|
@@ -217,7 +223,7 @@ const { status, data } = await apiInstance.getTraits(
|
|
|
217
223
|
|
|
218
224
|
### Return type
|
|
219
225
|
|
|
220
|
-
**
|
|
226
|
+
**PaginationResponseTraitDTO**
|
|
221
227
|
|
|
222
228
|
### Authorization
|
|
223
229
|
|
|
@@ -226,15 +232,17 @@ const { status, data } = await apiInstance.getTraits(
|
|
|
226
232
|
### HTTP request headers
|
|
227
233
|
|
|
228
234
|
- **Content-Type**: Not defined
|
|
229
|
-
- **Accept**: application/json
|
|
235
|
+
- **Accept**: application/json
|
|
230
236
|
|
|
231
237
|
|
|
232
238
|
### HTTP response details
|
|
233
239
|
| Status code | Description | Response headers |
|
|
234
240
|
|-------------|-------------|------------------|
|
|
235
241
|
|**200** | Traits retrieved successfully | - |
|
|
236
|
-
|**404** |
|
|
237
|
-
|**500** |
|
|
242
|
+
|**404** | The requested resource was not found. | - |
|
|
243
|
+
|**500** | An internal server error occurred. | - |
|
|
244
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
245
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
238
246
|
|
|
239
247
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
240
248
|
|
|
@@ -294,7 +302,7 @@ void (empty response body)
|
|
|
294
302
|
### HTTP request headers
|
|
295
303
|
|
|
296
304
|
- **Content-Type**: Not defined
|
|
297
|
-
- **Accept**: text/html
|
|
305
|
+
- **Accept**: text/html, application/json
|
|
298
306
|
|
|
299
307
|
|
|
300
308
|
### HTTP response details
|
|
@@ -302,9 +310,10 @@ void (empty response body)
|
|
|
302
310
|
|-------------|-------------|------------------|
|
|
303
311
|
|**200** | HTML choice, login, success, or error page | - |
|
|
304
312
|
|**400** | Invalid partstat or scope | - |
|
|
305
|
-
|**401** |
|
|
306
|
-
|**403** |
|
|
307
|
-
|**404** |
|
|
313
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
314
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
315
|
+
|**404** | The requested resource was not found. | - |
|
|
316
|
+
|**500** | An internal server error occurred. | - |
|
|
308
317
|
|
|
309
318
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
310
319
|
|
|
@@ -366,13 +375,17 @@ void (empty response body)
|
|
|
366
375
|
### HTTP request headers
|
|
367
376
|
|
|
368
377
|
- **Content-Type**: application/x-www-form-urlencoded
|
|
369
|
-
- **Accept**:
|
|
378
|
+
- **Accept**: application/json
|
|
370
379
|
|
|
371
380
|
|
|
372
381
|
### HTTP response details
|
|
373
382
|
| Status code | Description | Response headers |
|
|
374
383
|
|-------------|-------------|------------------|
|
|
375
384
|
|**200** | OK | - |
|
|
385
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
386
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
387
|
+
|**404** | The requested resource was not found. | - |
|
|
388
|
+
|**500** | An internal server error occurred. | - |
|
|
376
389
|
|
|
377
390
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
378
391
|
|
|
@@ -431,13 +444,17 @@ void (empty response body)
|
|
|
431
444
|
### HTTP request headers
|
|
432
445
|
|
|
433
446
|
- **Content-Type**: Not defined
|
|
434
|
-
- **Accept**:
|
|
447
|
+
- **Accept**: application/json
|
|
435
448
|
|
|
436
449
|
|
|
437
450
|
### HTTP response details
|
|
438
451
|
| Status code | Description | Response headers |
|
|
439
452
|
|-------------|-------------|------------------|
|
|
440
453
|
|**200** | OK | - |
|
|
454
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
455
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
456
|
+
|**404** | The requested resource was not found. | - |
|
|
457
|
+
|**500** | An internal server error occurred. | - |
|
|
441
458
|
|
|
442
459
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
443
460
|
|
|
@@ -503,6 +520,7 @@ const { status, data } = await apiInstance.rsvpJson(
|
|
|
503
520
|
|**401** | Login required | - |
|
|
504
521
|
|**403** | Not the invited attendee | - |
|
|
505
522
|
|**404** | Event, attendee, or invitation not found | - |
|
|
523
|
+
|**500** | An internal server error occurred. | - |
|
|
506
524
|
|
|
507
525
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
508
526
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# UpdateResponseFeedDTO
|
|
2
|
+
|
|
3
|
+
Represents the response returned after a successful update operation.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**FeedDTO**](FeedDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateResponseFeedDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateResponseFeedDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/ViewsApi.md
CHANGED
|
@@ -65,7 +65,10 @@ const { status, data } = await apiInstance.createView(
|
|
|
65
65
|
|-------------|-------------|------------------|
|
|
66
66
|
|**201** | View created successfully | - |
|
|
67
67
|
|**400** | Invalid input data | - |
|
|
68
|
-
|**500** |
|
|
68
|
+
|**500** | An internal server error occurred. | - |
|
|
69
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
70
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
71
|
+
|**404** | The requested resource was not found. | - |
|
|
69
72
|
|
|
70
73
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
71
74
|
|
|
@@ -113,15 +116,17 @@ const { status, data } = await apiInstance.deleteView(
|
|
|
113
116
|
### HTTP request headers
|
|
114
117
|
|
|
115
118
|
- **Content-Type**: Not defined
|
|
116
|
-
- **Accept**: application/json
|
|
119
|
+
- **Accept**: application/json
|
|
117
120
|
|
|
118
121
|
|
|
119
122
|
### HTTP response details
|
|
120
123
|
| Status code | Description | Response headers |
|
|
121
124
|
|-------------|-------------|------------------|
|
|
122
125
|
|**200** | View deleted successfully | - |
|
|
123
|
-
|**404** |
|
|
124
|
-
|**500** |
|
|
126
|
+
|**404** | The requested resource was not found. | - |
|
|
127
|
+
|**500** | An internal server error occurred. | - |
|
|
128
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
129
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
125
130
|
|
|
126
131
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
127
132
|
|
|
@@ -169,20 +174,22 @@ const { status, data } = await apiInstance.favoriteView(
|
|
|
169
174
|
### HTTP request headers
|
|
170
175
|
|
|
171
176
|
- **Content-Type**: Not defined
|
|
172
|
-
- **Accept**: application/json
|
|
177
|
+
- **Accept**: application/json
|
|
173
178
|
|
|
174
179
|
|
|
175
180
|
### HTTP response details
|
|
176
181
|
| Status code | Description | Response headers |
|
|
177
182
|
|-------------|-------------|------------------|
|
|
178
183
|
|**200** | View favorite status updated successfully | - |
|
|
179
|
-
|**404** |
|
|
180
|
-
|**500** |
|
|
184
|
+
|**404** | The requested resource was not found. | - |
|
|
185
|
+
|**500** | An internal server error occurred. | - |
|
|
186
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
187
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
181
188
|
|
|
182
189
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
183
190
|
|
|
184
191
|
# **getView**
|
|
185
|
-
>
|
|
192
|
+
> ShowResponseViewDTO getView()
|
|
186
193
|
|
|
187
194
|
Retrieves detailed information for a view identified by its UUID for the specified object. Returns a ShowResponse containing the ViewDTO.
|
|
188
195
|
|
|
@@ -216,7 +223,7 @@ const { status, data } = await apiInstance.getView(
|
|
|
216
223
|
|
|
217
224
|
### Return type
|
|
218
225
|
|
|
219
|
-
**
|
|
226
|
+
**ShowResponseViewDTO**
|
|
220
227
|
|
|
221
228
|
### Authorization
|
|
222
229
|
|
|
@@ -225,20 +232,22 @@ const { status, data } = await apiInstance.getView(
|
|
|
225
232
|
### HTTP request headers
|
|
226
233
|
|
|
227
234
|
- **Content-Type**: Not defined
|
|
228
|
-
- **Accept**: application/json
|
|
235
|
+
- **Accept**: application/json
|
|
229
236
|
|
|
230
237
|
|
|
231
238
|
### HTTP response details
|
|
232
239
|
| Status code | Description | Response headers |
|
|
233
240
|
|-------------|-------------|------------------|
|
|
234
241
|
|**200** | View retrieved successfully | - |
|
|
235
|
-
|**404** |
|
|
236
|
-
|**500** |
|
|
242
|
+
|**404** | The requested resource was not found. | - |
|
|
243
|
+
|**500** | An internal server error occurred. | - |
|
|
244
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
245
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
237
246
|
|
|
238
247
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
239
248
|
|
|
240
249
|
# **getViews**
|
|
241
|
-
>
|
|
250
|
+
> PaginationResponseViewDTO getViews(paginationRequest)
|
|
242
251
|
|
|
243
252
|
Retrieves a paginated list of views for the specified object. A custom Cypher query is used to filter views based on the object\'s UUID. Returns a PaginationResponse containing ViewDTO objects.
|
|
244
253
|
|
|
@@ -247,18 +256,19 @@ Retrieves a paginated list of views for the specified object. A custom Cypher qu
|
|
|
247
256
|
```typescript
|
|
248
257
|
import {
|
|
249
258
|
ViewsApi,
|
|
250
|
-
Configuration
|
|
259
|
+
Configuration,
|
|
260
|
+
PaginationRequest
|
|
251
261
|
} from '@caraer/client';
|
|
252
262
|
|
|
253
263
|
const configuration = new Configuration();
|
|
254
264
|
const apiInstance = new ViewsApi(configuration);
|
|
255
265
|
|
|
256
266
|
let objectUuid: string; // (default to undefined)
|
|
257
|
-
let
|
|
267
|
+
let paginationRequest: PaginationRequest; //Pagination request details (limit, page, filters, sort, query)
|
|
258
268
|
|
|
259
269
|
const { status, data } = await apiInstance.getViews(
|
|
260
270
|
objectUuid,
|
|
261
|
-
|
|
271
|
+
paginationRequest
|
|
262
272
|
);
|
|
263
273
|
```
|
|
264
274
|
|
|
@@ -266,13 +276,13 @@ const { status, data } = await apiInstance.getViews(
|
|
|
266
276
|
|
|
267
277
|
|Name | Type | Description | Notes|
|
|
268
278
|
|------------- | ------------- | ------------- | -------------|
|
|
269
|
-
| **
|
|
279
|
+
| **paginationRequest** | **PaginationRequest**| Pagination request details (limit, page, filters, sort, query) | |
|
|
270
280
|
| **objectUuid** | [**string**] | | defaults to undefined|
|
|
271
281
|
|
|
272
282
|
|
|
273
283
|
### Return type
|
|
274
284
|
|
|
275
|
-
**
|
|
285
|
+
**PaginationResponseViewDTO**
|
|
276
286
|
|
|
277
287
|
### Authorization
|
|
278
288
|
|
|
@@ -290,11 +300,14 @@ const { status, data } = await apiInstance.getViews(
|
|
|
290
300
|
|**200** | Views fetched successfully | - |
|
|
291
301
|
|**400** | Invalid pagination request | - |
|
|
292
302
|
|**500** | Internal server error | - |
|
|
303
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
304
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
305
|
+
|**404** | The requested resource was not found. | - |
|
|
293
306
|
|
|
294
307
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
295
308
|
|
|
296
309
|
# **updateIndices1**
|
|
297
|
-
>
|
|
310
|
+
> SuccessResponseString updateIndices1(requestBody)
|
|
298
311
|
|
|
299
312
|
Updates the indices for views associated with the specified object. The request body must include a mapping of view UUIDs to their new index values. Returns a SuccessResponse with the updated view DTOs.
|
|
300
313
|
|
|
@@ -310,11 +323,11 @@ const configuration = new Configuration();
|
|
|
310
323
|
const apiInstance = new ViewsApi(configuration);
|
|
311
324
|
|
|
312
325
|
let objectUuid: string; // (default to undefined)
|
|
313
|
-
let
|
|
326
|
+
let requestBody: { [key: string]: number; }; //Mapping of view UUIDs to new index values
|
|
314
327
|
|
|
315
328
|
const { status, data } = await apiInstance.updateIndices1(
|
|
316
329
|
objectUuid,
|
|
317
|
-
|
|
330
|
+
requestBody
|
|
318
331
|
);
|
|
319
332
|
```
|
|
320
333
|
|
|
@@ -322,13 +335,13 @@ const { status, data } = await apiInstance.updateIndices1(
|
|
|
322
335
|
|
|
323
336
|
|Name | Type | Description | Notes|
|
|
324
337
|
|------------- | ------------- | ------------- | -------------|
|
|
325
|
-
| **
|
|
338
|
+
| **requestBody** | **{ [key: string]: number; }**| Mapping of view UUIDs to new index values | |
|
|
326
339
|
| **objectUuid** | [**string**] | | defaults to undefined|
|
|
327
340
|
|
|
328
341
|
|
|
329
342
|
### Return type
|
|
330
343
|
|
|
331
|
-
**
|
|
344
|
+
**SuccessResponseString**
|
|
332
345
|
|
|
333
346
|
### Authorization
|
|
334
347
|
|
|
@@ -345,7 +358,10 @@ const { status, data } = await apiInstance.updateIndices1(
|
|
|
345
358
|
|-------------|-------------|------------------|
|
|
346
359
|
|**200** | View indices updated successfully | - |
|
|
347
360
|
|**400** | Invalid input provided | - |
|
|
348
|
-
|**500** |
|
|
361
|
+
|**500** | An internal server error occurred. | - |
|
|
362
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
363
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
364
|
+
|**404** | The requested resource was not found. | - |
|
|
349
365
|
|
|
350
366
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
351
367
|
|
|
@@ -405,8 +421,10 @@ const { status, data } = await apiInstance.updateView(
|
|
|
405
421
|
|-------------|-------------|------------------|
|
|
406
422
|
|**200** | View updated successfully | - |
|
|
407
423
|
|**400** | Invalid input data | - |
|
|
408
|
-
|**404** |
|
|
409
|
-
|**500** |
|
|
424
|
+
|**404** | The requested resource was not found. | - |
|
|
425
|
+
|**500** | An internal server error occurred. | - |
|
|
426
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
427
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
410
428
|
|
|
411
429
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
412
430
|
|
package/docs/WebMenusApi.md
CHANGED
|
@@ -62,6 +62,9 @@ const { status, data } = await apiInstance.createWebMenu(
|
|
|
62
62
|
|**200** | Web menu created successfully | - |
|
|
63
63
|
|**400** | Bad request | - |
|
|
64
64
|
|**500** | Internal server error | - |
|
|
65
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
66
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
67
|
+
|**404** | The requested resource was not found. | - |
|
|
65
68
|
|
|
66
69
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
67
70
|
|
|
@@ -114,12 +117,15 @@ const { status, data } = await apiInstance.deleteWebMenu(
|
|
|
114
117
|
|-------------|-------------|------------------|
|
|
115
118
|
|**200** | Web menu deleted successfully | - |
|
|
116
119
|
|**400** | Bad request | - |
|
|
117
|
-
|**500** |
|
|
120
|
+
|**500** | An internal server error occurred. | - |
|
|
121
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
122
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
123
|
+
|**404** | The requested resource was not found. | - |
|
|
118
124
|
|
|
119
125
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
120
126
|
|
|
121
127
|
# **getWebMenu**
|
|
122
|
-
>
|
|
128
|
+
> ShowResponseWebMenuDTO getWebMenu()
|
|
123
129
|
|
|
124
130
|
Show web menu
|
|
125
131
|
|
|
@@ -150,7 +156,7 @@ const { status, data } = await apiInstance.getWebMenu(
|
|
|
150
156
|
|
|
151
157
|
### Return type
|
|
152
158
|
|
|
153
|
-
**
|
|
159
|
+
**ShowResponseWebMenuDTO**
|
|
154
160
|
|
|
155
161
|
### Authorization
|
|
156
162
|
|
|
@@ -168,11 +174,14 @@ const { status, data } = await apiInstance.getWebMenu(
|
|
|
168
174
|
|**200** | Web menu shown successfully | - |
|
|
169
175
|
|**400** | Bad request | - |
|
|
170
176
|
|**500** | Internal server error | - |
|
|
177
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
178
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
179
|
+
|**404** | The requested resource was not found. | - |
|
|
171
180
|
|
|
172
181
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
173
182
|
|
|
174
183
|
# **indexWebMenus**
|
|
175
|
-
>
|
|
184
|
+
> PaginationResponseWebMenuDTO indexWebMenus(paginationRequest)
|
|
176
185
|
|
|
177
186
|
Index web menus
|
|
178
187
|
|
|
@@ -181,16 +190,17 @@ Index web menus
|
|
|
181
190
|
```typescript
|
|
182
191
|
import {
|
|
183
192
|
WebMenusApi,
|
|
184
|
-
Configuration
|
|
193
|
+
Configuration,
|
|
194
|
+
PaginationRequest
|
|
185
195
|
} from '@caraer/client';
|
|
186
196
|
|
|
187
197
|
const configuration = new Configuration();
|
|
188
198
|
const apiInstance = new WebMenusApi(configuration);
|
|
189
199
|
|
|
190
|
-
let
|
|
200
|
+
let paginationRequest: PaginationRequest; //
|
|
191
201
|
|
|
192
202
|
const { status, data } = await apiInstance.indexWebMenus(
|
|
193
|
-
|
|
203
|
+
paginationRequest
|
|
194
204
|
);
|
|
195
205
|
```
|
|
196
206
|
|
|
@@ -198,12 +208,12 @@ const { status, data } = await apiInstance.indexWebMenus(
|
|
|
198
208
|
|
|
199
209
|
|Name | Type | Description | Notes|
|
|
200
210
|
|------------- | ------------- | ------------- | -------------|
|
|
201
|
-
| **
|
|
211
|
+
| **paginationRequest** | **PaginationRequest**| | |
|
|
202
212
|
|
|
203
213
|
|
|
204
214
|
### Return type
|
|
205
215
|
|
|
206
|
-
**
|
|
216
|
+
**PaginationResponseWebMenuDTO**
|
|
207
217
|
|
|
208
218
|
### Authorization
|
|
209
219
|
|
|
@@ -221,6 +231,9 @@ const { status, data } = await apiInstance.indexWebMenus(
|
|
|
221
231
|
|**200** | Web menus indexed successfully | - |
|
|
222
232
|
|**400** | Bad request | - |
|
|
223
233
|
|**500** | Internal server error | - |
|
|
234
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
235
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
236
|
+
|**404** | The requested resource was not found. | - |
|
|
224
237
|
|
|
225
238
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
226
239
|
|
|
@@ -265,15 +278,17 @@ const { status, data } = await apiInstance.restoreWebMenu(
|
|
|
265
278
|
### HTTP request headers
|
|
266
279
|
|
|
267
280
|
- **Content-Type**: Not defined
|
|
268
|
-
- **Accept**: application/json
|
|
281
|
+
- **Accept**: application/json
|
|
269
282
|
|
|
270
283
|
|
|
271
284
|
### HTTP response details
|
|
272
285
|
| Status code | Description | Response headers |
|
|
273
286
|
|-------------|-------------|------------------|
|
|
274
287
|
|**200** | Web menu restored successfully | - |
|
|
275
|
-
|**404** |
|
|
276
|
-
|**500** |
|
|
288
|
+
|**404** | The requested resource was not found. | - |
|
|
289
|
+
|**500** | An internal server error occurred. | - |
|
|
290
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
291
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
277
292
|
|
|
278
293
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
279
294
|
|
|
@@ -331,6 +346,9 @@ const { status, data } = await apiInstance.updateWebMenu(
|
|
|
331
346
|
|**200** | Web menu updated successfully | - |
|
|
332
347
|
|**400** | Bad request | - |
|
|
333
348
|
|**500** | Internal server error | - |
|
|
349
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
350
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
351
|
+
|**404** | The requested resource was not found. | - |
|
|
334
352
|
|
|
335
353
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
336
354
|
|