@caraer/client 2.0.437 → 2.0.442
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 +2040 -714
- package/dist/api.js +471 -465
- package/dist/esm/api.d.ts +2040 -714
- 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 +2 -2
- 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/SettingField.md +2 -2
- 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/RelationsApi.md
CHANGED
|
@@ -18,7 +18,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
18
18
|
|[**updateIndices**](#updateindices) | **PUT** /api/v2/relations/updateIndices | Update relation indices|
|
|
19
19
|
|
|
20
20
|
# **addConnection**
|
|
21
|
-
>
|
|
21
|
+
> SuccessResponseString addConnection()
|
|
22
22
|
|
|
23
23
|
Creates a connection between two objects for a given relation. The \'from\' and \'to\' UUIDs identify the objects to connect.
|
|
24
24
|
|
|
@@ -55,7 +55,7 @@ const { status, data } = await apiInstance.addConnection(
|
|
|
55
55
|
|
|
56
56
|
### Return type
|
|
57
57
|
|
|
58
|
-
**
|
|
58
|
+
**SuccessResponseString**
|
|
59
59
|
|
|
60
60
|
### Authorization
|
|
61
61
|
|
|
@@ -64,15 +64,17 @@ const { status, data } = await apiInstance.addConnection(
|
|
|
64
64
|
### HTTP request headers
|
|
65
65
|
|
|
66
66
|
- **Content-Type**: Not defined
|
|
67
|
-
- **Accept**: application/json
|
|
67
|
+
- **Accept**: application/json
|
|
68
68
|
|
|
69
69
|
|
|
70
70
|
### HTTP response details
|
|
71
71
|
| Status code | Description | Response headers |
|
|
72
72
|
|-------------|-------------|------------------|
|
|
73
73
|
|**200** | Connection created successfully | - |
|
|
74
|
-
|**404** |
|
|
75
|
-
|**500** |
|
|
74
|
+
|**404** | The requested resource was not found. | - |
|
|
75
|
+
|**500** | An internal server error occurred. | - |
|
|
76
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
77
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
76
78
|
|
|
77
79
|
[[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)
|
|
78
80
|
|
|
@@ -130,12 +132,15 @@ const { status, data } = await apiInstance.createRelationOrUpdate(
|
|
|
130
132
|
|**200** | Relation updated successfully | - |
|
|
131
133
|
|**201** | Relation created successfully | - |
|
|
132
134
|
|**400** | Invalid input data | - |
|
|
133
|
-
|**500** |
|
|
135
|
+
|**500** | An internal server error occurred. | - |
|
|
136
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
137
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
138
|
+
|**404** | The requested resource was not found. | - |
|
|
134
139
|
|
|
135
140
|
[[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)
|
|
136
141
|
|
|
137
142
|
# **deleteConnection**
|
|
138
|
-
>
|
|
143
|
+
> SuccessResponseString deleteConnection()
|
|
139
144
|
|
|
140
145
|
Deletes a connection between two objects for a given relation using the specified UUIDs.
|
|
141
146
|
|
|
@@ -172,7 +177,7 @@ const { status, data } = await apiInstance.deleteConnection(
|
|
|
172
177
|
|
|
173
178
|
### Return type
|
|
174
179
|
|
|
175
|
-
**
|
|
180
|
+
**SuccessResponseString**
|
|
176
181
|
|
|
177
182
|
### Authorization
|
|
178
183
|
|
|
@@ -181,15 +186,17 @@ const { status, data } = await apiInstance.deleteConnection(
|
|
|
181
186
|
### HTTP request headers
|
|
182
187
|
|
|
183
188
|
- **Content-Type**: Not defined
|
|
184
|
-
- **Accept**: application/json
|
|
189
|
+
- **Accept**: application/json
|
|
185
190
|
|
|
186
191
|
|
|
187
192
|
### HTTP response details
|
|
188
193
|
| Status code | Description | Response headers |
|
|
189
194
|
|-------------|-------------|------------------|
|
|
190
195
|
|**200** | Connection deleted successfully | - |
|
|
191
|
-
|**404** |
|
|
192
|
-
|**500** |
|
|
196
|
+
|**404** | The requested resource was not found. | - |
|
|
197
|
+
|**500** | An internal server error occurred. | - |
|
|
198
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
199
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
193
200
|
|
|
194
201
|
[[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)
|
|
195
202
|
|
|
@@ -234,20 +241,22 @@ const { status, data } = await apiInstance.deleteRelation1(
|
|
|
234
241
|
### HTTP request headers
|
|
235
242
|
|
|
236
243
|
- **Content-Type**: Not defined
|
|
237
|
-
- **Accept**: application/json
|
|
244
|
+
- **Accept**: application/json
|
|
238
245
|
|
|
239
246
|
|
|
240
247
|
### HTTP response details
|
|
241
248
|
| Status code | Description | Response headers |
|
|
242
249
|
|-------------|-------------|------------------|
|
|
243
250
|
|**200** | Relation deleted successfully | - |
|
|
244
|
-
|**404** |
|
|
245
|
-
|**500** |
|
|
251
|
+
|**404** | The requested resource was not found. | - |
|
|
252
|
+
|**500** | An internal server error occurred. | - |
|
|
253
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
254
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
246
255
|
|
|
247
256
|
[[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)
|
|
248
257
|
|
|
249
258
|
# **getRelation**
|
|
250
|
-
>
|
|
259
|
+
> ShowResponseRelationDTO getRelation()
|
|
251
260
|
|
|
252
261
|
Retrieves the details of a relation by its UUID. Returns a ShowResponse containing a RelationDTO.
|
|
253
262
|
|
|
@@ -278,7 +287,7 @@ const { status, data } = await apiInstance.getRelation(
|
|
|
278
287
|
|
|
279
288
|
### Return type
|
|
280
289
|
|
|
281
|
-
**
|
|
290
|
+
**ShowResponseRelationDTO**
|
|
282
291
|
|
|
283
292
|
### Authorization
|
|
284
293
|
|
|
@@ -287,19 +296,22 @@ const { status, data } = await apiInstance.getRelation(
|
|
|
287
296
|
### HTTP request headers
|
|
288
297
|
|
|
289
298
|
- **Content-Type**: Not defined
|
|
290
|
-
- **Accept**: application/json
|
|
299
|
+
- **Accept**: application/json
|
|
291
300
|
|
|
292
301
|
|
|
293
302
|
### HTTP response details
|
|
294
303
|
| Status code | Description | Response headers |
|
|
295
304
|
|-------------|-------------|------------------|
|
|
296
305
|
|**200** | Relation retrieved successfully | - |
|
|
297
|
-
|**404** |
|
|
306
|
+
|**404** | The requested resource was not found. | - |
|
|
307
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
308
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
309
|
+
|**500** | An internal server error occurred. | - |
|
|
298
310
|
|
|
299
311
|
[[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)
|
|
300
312
|
|
|
301
313
|
# **getRelationForObject**
|
|
302
|
-
>
|
|
314
|
+
> ShowResponseRelationDTO getRelationForObject()
|
|
303
315
|
|
|
304
316
|
Retrieves a relation by its UUID and associates it with the specified object, returning a RelationDTO that includes details from the related object.
|
|
305
317
|
|
|
@@ -333,7 +345,7 @@ const { status, data } = await apiInstance.getRelationForObject(
|
|
|
333
345
|
|
|
334
346
|
### Return type
|
|
335
347
|
|
|
336
|
-
**
|
|
348
|
+
**ShowResponseRelationDTO**
|
|
337
349
|
|
|
338
350
|
### Authorization
|
|
339
351
|
|
|
@@ -350,11 +362,14 @@ const { status, data } = await apiInstance.getRelationForObject(
|
|
|
350
362
|
|-------------|-------------|------------------|
|
|
351
363
|
|**200** | Relation for object retrieved successfully | - |
|
|
352
364
|
|**404** | Relation or object not found | - |
|
|
365
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
366
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
367
|
+
|**500** | An internal server error occurred. | - |
|
|
353
368
|
|
|
354
369
|
[[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)
|
|
355
370
|
|
|
356
371
|
# **getRelations**
|
|
357
|
-
>
|
|
372
|
+
> PaginationResponseRelationDTO getRelations(paginationRequest)
|
|
358
373
|
|
|
359
374
|
Retrieves a paginated list of relations. Returns a PaginationResponse containing RelationDTO objects based on the provided pagination criteria.
|
|
360
375
|
|
|
@@ -363,16 +378,17 @@ Retrieves a paginated list of relations. Returns a PaginationResponse containing
|
|
|
363
378
|
```typescript
|
|
364
379
|
import {
|
|
365
380
|
RelationsApi,
|
|
366
|
-
Configuration
|
|
381
|
+
Configuration,
|
|
382
|
+
PaginationRequest
|
|
367
383
|
} from '@caraer/client';
|
|
368
384
|
|
|
369
385
|
const configuration = new Configuration();
|
|
370
386
|
const apiInstance = new RelationsApi(configuration);
|
|
371
387
|
|
|
372
|
-
let
|
|
388
|
+
let paginationRequest: PaginationRequest; //Pagination request for relations
|
|
373
389
|
|
|
374
390
|
const { status, data } = await apiInstance.getRelations(
|
|
375
|
-
|
|
391
|
+
paginationRequest
|
|
376
392
|
);
|
|
377
393
|
```
|
|
378
394
|
|
|
@@ -380,12 +396,12 @@ const { status, data } = await apiInstance.getRelations(
|
|
|
380
396
|
|
|
381
397
|
|Name | Type | Description | Notes|
|
|
382
398
|
|------------- | ------------- | ------------- | -------------|
|
|
383
|
-
| **
|
|
399
|
+
| **paginationRequest** | **PaginationRequest**| Pagination request for relations | |
|
|
384
400
|
|
|
385
401
|
|
|
386
402
|
### Return type
|
|
387
403
|
|
|
388
|
-
**
|
|
404
|
+
**PaginationResponseRelationDTO**
|
|
389
405
|
|
|
390
406
|
### Authorization
|
|
391
407
|
|
|
@@ -403,11 +419,14 @@ const { status, data } = await apiInstance.getRelations(
|
|
|
403
419
|
|**200** | Relations fetched successfully | - |
|
|
404
420
|
|**400** | Invalid pagination request | - |
|
|
405
421
|
|**500** | Internal server error | - |
|
|
422
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
423
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
424
|
+
|**404** | The requested resource was not found. | - |
|
|
406
425
|
|
|
407
426
|
[[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)
|
|
408
427
|
|
|
409
428
|
# **getRelationsBetweenObjects**
|
|
410
|
-
>
|
|
429
|
+
> PaginationResponseRelationDTO getRelationsBetweenObjects(paginationRequest)
|
|
411
430
|
|
|
412
431
|
Retrieves all relations between two objects based on the provided object UUIDs.
|
|
413
432
|
|
|
@@ -416,7 +435,8 @@ Retrieves all relations between two objects based on the provided object UUIDs.
|
|
|
416
435
|
```typescript
|
|
417
436
|
import {
|
|
418
437
|
RelationsApi,
|
|
419
|
-
Configuration
|
|
438
|
+
Configuration,
|
|
439
|
+
PaginationRequest
|
|
420
440
|
} from '@caraer/client';
|
|
421
441
|
|
|
422
442
|
const configuration = new Configuration();
|
|
@@ -424,12 +444,12 @@ const apiInstance = new RelationsApi(configuration);
|
|
|
424
444
|
|
|
425
445
|
let fromObjectUuid: string; // (default to undefined)
|
|
426
446
|
let toObjectUuid: string; // (default to undefined)
|
|
427
|
-
let
|
|
447
|
+
let paginationRequest: PaginationRequest; //
|
|
428
448
|
|
|
429
449
|
const { status, data } = await apiInstance.getRelationsBetweenObjects(
|
|
430
450
|
fromObjectUuid,
|
|
431
451
|
toObjectUuid,
|
|
432
|
-
|
|
452
|
+
paginationRequest
|
|
433
453
|
);
|
|
434
454
|
```
|
|
435
455
|
|
|
@@ -437,14 +457,14 @@ const { status, data } = await apiInstance.getRelationsBetweenObjects(
|
|
|
437
457
|
|
|
438
458
|
|Name | Type | Description | Notes|
|
|
439
459
|
|------------- | ------------- | ------------- | -------------|
|
|
440
|
-
| **
|
|
460
|
+
| **paginationRequest** | **PaginationRequest**| | |
|
|
441
461
|
| **fromObjectUuid** | [**string**] | | defaults to undefined|
|
|
442
462
|
| **toObjectUuid** | [**string**] | | defaults to undefined|
|
|
443
463
|
|
|
444
464
|
|
|
445
465
|
### Return type
|
|
446
466
|
|
|
447
|
-
**
|
|
467
|
+
**PaginationResponseRelationDTO**
|
|
448
468
|
|
|
449
469
|
### Authorization
|
|
450
470
|
|
|
@@ -461,11 +481,14 @@ const { status, data } = await apiInstance.getRelationsBetweenObjects(
|
|
|
461
481
|
|-------------|-------------|------------------|
|
|
462
482
|
|**200** | Relations retrieved successfully | - |
|
|
463
483
|
|**404** | One or more objects not found | - |
|
|
484
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
485
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
486
|
+
|**500** | An internal server error occurred. | - |
|
|
464
487
|
|
|
465
488
|
[[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)
|
|
466
489
|
|
|
467
490
|
# **getRelationsByObject**
|
|
468
|
-
>
|
|
491
|
+
> PaginationResponseRelationDTO getRelationsByObject(paginationRequest)
|
|
469
492
|
|
|
470
493
|
Returns relation definitions where this object participates in the **schema** graph for that relation name: either as origin `(thisObject)-[:relationName]->(:Object)` or as target `(:Object)-[:relationName]->(thisObject)`. Unrelated relations (same name elsewhere, or no typed edge touching this object) are excluded. Uses the object’s `name` to filter; request path uses object UUID.
|
|
471
494
|
|
|
@@ -474,18 +497,19 @@ Returns relation definitions where this object participates in the **schema** gr
|
|
|
474
497
|
```typescript
|
|
475
498
|
import {
|
|
476
499
|
RelationsApi,
|
|
477
|
-
Configuration
|
|
500
|
+
Configuration,
|
|
501
|
+
PaginationRequest
|
|
478
502
|
} from '@caraer/client';
|
|
479
503
|
|
|
480
504
|
const configuration = new Configuration();
|
|
481
505
|
const apiInstance = new RelationsApi(configuration);
|
|
482
506
|
|
|
483
507
|
let objectUuid: string; // (default to undefined)
|
|
484
|
-
let
|
|
508
|
+
let paginationRequest: PaginationRequest; //Pagination request for relations
|
|
485
509
|
|
|
486
510
|
const { status, data } = await apiInstance.getRelationsByObject(
|
|
487
511
|
objectUuid,
|
|
488
|
-
|
|
512
|
+
paginationRequest
|
|
489
513
|
);
|
|
490
514
|
```
|
|
491
515
|
|
|
@@ -493,13 +517,13 @@ const { status, data } = await apiInstance.getRelationsByObject(
|
|
|
493
517
|
|
|
494
518
|
|Name | Type | Description | Notes|
|
|
495
519
|
|------------- | ------------- | ------------- | -------------|
|
|
496
|
-
| **
|
|
520
|
+
| **paginationRequest** | **PaginationRequest**| Pagination request for relations | |
|
|
497
521
|
| **objectUuid** | [**string**] | | defaults to undefined|
|
|
498
522
|
|
|
499
523
|
|
|
500
524
|
### Return type
|
|
501
525
|
|
|
502
|
-
**
|
|
526
|
+
**PaginationResponseRelationDTO**
|
|
503
527
|
|
|
504
528
|
### Authorization
|
|
505
529
|
|
|
@@ -517,6 +541,8 @@ const { status, data } = await apiInstance.getRelationsByObject(
|
|
|
517
541
|
|**200** | Relations fetched successfully | - |
|
|
518
542
|
|**404** | Object not found | - |
|
|
519
543
|
|**500** | Internal server error | - |
|
|
544
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
545
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
520
546
|
|
|
521
547
|
[[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)
|
|
522
548
|
|
|
@@ -569,7 +595,10 @@ const { status, data } = await apiInstance.permanentlyDeleteArchivedRelation(
|
|
|
569
595
|
|-------------|-------------|------------------|
|
|
570
596
|
|**200** | Relation permanently deleted | - |
|
|
571
597
|
|**400** | Relation is not archived | - |
|
|
572
|
-
|**404** |
|
|
598
|
+
|**404** | The requested resource was not found. | - |
|
|
599
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
600
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
601
|
+
|**500** | An internal server error occurred. | - |
|
|
573
602
|
|
|
574
603
|
[[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)
|
|
575
604
|
|
|
@@ -614,20 +643,22 @@ const { status, data } = await apiInstance.restoreRelation(
|
|
|
614
643
|
### HTTP request headers
|
|
615
644
|
|
|
616
645
|
- **Content-Type**: Not defined
|
|
617
|
-
- **Accept**: application/json
|
|
646
|
+
- **Accept**: application/json
|
|
618
647
|
|
|
619
648
|
|
|
620
649
|
### HTTP response details
|
|
621
650
|
| Status code | Description | Response headers |
|
|
622
651
|
|-------------|-------------|------------------|
|
|
623
652
|
|**200** | Relation restored successfully | - |
|
|
624
|
-
|**404** |
|
|
625
|
-
|**500** |
|
|
653
|
+
|**404** | The requested resource was not found. | - |
|
|
654
|
+
|**500** | An internal server error occurred. | - |
|
|
655
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
656
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
626
657
|
|
|
627
658
|
[[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)
|
|
628
659
|
|
|
629
660
|
# **updateIndices**
|
|
630
|
-
>
|
|
661
|
+
> SuccessResponseCollectionRelation updateIndices(requestBody)
|
|
631
662
|
|
|
632
663
|
Updates the indices for relations. The request body should contain a mapping of relation UUIDs to their new index values. Returns a SuccessResponse containing the updated relation objects.
|
|
633
664
|
|
|
@@ -642,10 +673,10 @@ import {
|
|
|
642
673
|
const configuration = new Configuration();
|
|
643
674
|
const apiInstance = new RelationsApi(configuration);
|
|
644
675
|
|
|
645
|
-
let
|
|
676
|
+
let requestBody: { [key: string]: number; }; //Mapping of relation UUIDs to new index values
|
|
646
677
|
|
|
647
678
|
const { status, data } = await apiInstance.updateIndices(
|
|
648
|
-
|
|
679
|
+
requestBody
|
|
649
680
|
);
|
|
650
681
|
```
|
|
651
682
|
|
|
@@ -653,12 +684,12 @@ const { status, data } = await apiInstance.updateIndices(
|
|
|
653
684
|
|
|
654
685
|
|Name | Type | Description | Notes|
|
|
655
686
|
|------------- | ------------- | ------------- | -------------|
|
|
656
|
-
| **
|
|
687
|
+
| **requestBody** | **{ [key: string]: number; }**| Mapping of relation UUIDs to new index values | |
|
|
657
688
|
|
|
658
689
|
|
|
659
690
|
### Return type
|
|
660
691
|
|
|
661
|
-
**
|
|
692
|
+
**SuccessResponseCollectionRelation**
|
|
662
693
|
|
|
663
694
|
### Authorization
|
|
664
695
|
|
|
@@ -675,7 +706,10 @@ const { status, data } = await apiInstance.updateIndices(
|
|
|
675
706
|
|-------------|-------------|------------------|
|
|
676
707
|
|**200** | Indices updated successfully | - |
|
|
677
708
|
|**400** | Invalid input provided | - |
|
|
678
|
-
|**500** |
|
|
709
|
+
|**500** | An internal server error occurred. | - |
|
|
710
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
711
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
712
|
+
|**404** | The requested resource was not found. | - |
|
|
679
713
|
|
|
680
714
|
[[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)
|
|
681
715
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# SearchRequest
|
|
2
|
+
|
|
3
|
+
Request DTO for searching records.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**query** | **string** | The query to search for. | [optional] [default to undefined]
|
|
10
|
+
**objectUuid** | **string** | The UUID of the object to search in. | [optional] [default to undefined]
|
|
11
|
+
**limit** | **number** | The limit of the search. | [optional] [default to undefined]
|
|
12
|
+
**page** | **number** | The page of the search. | [optional] [default to undefined]
|
|
13
|
+
**preview** | **string** | The preview of the search. | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { SearchRequest } from '@caraer/client';
|
|
19
|
+
|
|
20
|
+
const instance: SearchRequest = {
|
|
21
|
+
query,
|
|
22
|
+
objectUuid,
|
|
23
|
+
limit,
|
|
24
|
+
page,
|
|
25
|
+
preview,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -66,6 +66,10 @@ const { status, data } = await apiInstance.create3(
|
|
|
66
66
|
|-------------|-------------|------------------|
|
|
67
67
|
|**200** | Successfully created serverless function | - |
|
|
68
68
|
|**400** | Invalid request or app not installed for company | - |
|
|
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. | - |
|
|
72
|
+
|**500** | An internal server error occurred. | - |
|
|
69
73
|
|
|
70
74
|
[[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
75
|
|
|
@@ -121,11 +125,14 @@ const { status, data } = await apiInstance.delete1(
|
|
|
121
125
|
|-------------|-------------|------------------|
|
|
122
126
|
|**200** | Successfully deleted serverless function | - |
|
|
123
127
|
|**404** | Serverless function not found for this app | - |
|
|
128
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
129
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
130
|
+
|**500** | An internal server error occurred. | - |
|
|
124
131
|
|
|
125
132
|
[[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)
|
|
126
133
|
|
|
127
134
|
# **index2**
|
|
128
|
-
>
|
|
135
|
+
> PaginationResponseServerlessFunctionDTO index2(paginationRequest)
|
|
129
136
|
|
|
130
137
|
Retrieves a paginated list of serverless functions that belong to the specified app.
|
|
131
138
|
|
|
@@ -134,18 +141,19 @@ Retrieves a paginated list of serverless functions that belong to the specified
|
|
|
134
141
|
```typescript
|
|
135
142
|
import {
|
|
136
143
|
ServerlessFunctionsApi,
|
|
137
|
-
Configuration
|
|
144
|
+
Configuration,
|
|
145
|
+
PaginationRequest
|
|
138
146
|
} from '@caraer/client';
|
|
139
147
|
|
|
140
148
|
const configuration = new Configuration();
|
|
141
149
|
const apiInstance = new ServerlessFunctionsApi(configuration);
|
|
142
150
|
|
|
143
151
|
let appUuid: string; //UUID of the app whose serverless functions to list (default to undefined)
|
|
144
|
-
let
|
|
152
|
+
let paginationRequest: PaginationRequest; //Pagination and filtering options for the request
|
|
145
153
|
|
|
146
154
|
const { status, data } = await apiInstance.index2(
|
|
147
155
|
appUuid,
|
|
148
|
-
|
|
156
|
+
paginationRequest
|
|
149
157
|
);
|
|
150
158
|
```
|
|
151
159
|
|
|
@@ -153,13 +161,13 @@ const { status, data } = await apiInstance.index2(
|
|
|
153
161
|
|
|
154
162
|
|Name | Type | Description | Notes|
|
|
155
163
|
|------------- | ------------- | ------------- | -------------|
|
|
156
|
-
| **
|
|
164
|
+
| **paginationRequest** | **PaginationRequest**| Pagination and filtering options for the request | |
|
|
157
165
|
| **appUuid** | [**string**] | UUID of the app whose serverless functions to list | defaults to undefined|
|
|
158
166
|
|
|
159
167
|
|
|
160
168
|
### Return type
|
|
161
169
|
|
|
162
|
-
**
|
|
170
|
+
**PaginationResponseServerlessFunctionDTO**
|
|
163
171
|
|
|
164
172
|
### Authorization
|
|
165
173
|
|
|
@@ -177,11 +185,14 @@ const { status, data } = await apiInstance.index2(
|
|
|
177
185
|
|**200** | Successfully retrieved serverless functions | - |
|
|
178
186
|
|**400** | Invalid request or app not installed for company | - |
|
|
179
187
|
|**401** | Unauthorized access | - |
|
|
188
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
189
|
+
|**404** | The requested resource was not found. | - |
|
|
190
|
+
|**500** | An internal server error occurred. | - |
|
|
180
191
|
|
|
181
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)
|
|
182
193
|
|
|
183
194
|
# **logs**
|
|
184
|
-
>
|
|
195
|
+
> SuccessResponseMapStringObject logs()
|
|
185
196
|
|
|
186
197
|
Queries Cloud Logging for recent log entries emitted by the Cloud Function backing this serverless function.
|
|
187
198
|
|
|
@@ -221,7 +232,7 @@ const { status, data } = await apiInstance.logs(
|
|
|
221
232
|
|
|
222
233
|
### Return type
|
|
223
234
|
|
|
224
|
-
**
|
|
235
|
+
**SuccessResponseMapStringObject**
|
|
225
236
|
|
|
226
237
|
### Authorization
|
|
227
238
|
|
|
@@ -238,11 +249,14 @@ const { status, data } = await apiInstance.logs(
|
|
|
238
249
|
|-------------|-------------|------------------|
|
|
239
250
|
|**200** | Successfully retrieved logs (may be empty if logging is unavailable) | - |
|
|
240
251
|
|**404** | Serverless function not found for this app | - |
|
|
252
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
253
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
254
|
+
|**500** | An internal server error occurred. | - |
|
|
241
255
|
|
|
242
256
|
[[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)
|
|
243
257
|
|
|
244
258
|
# **samplePayload**
|
|
245
|
-
>
|
|
259
|
+
> SuccessResponseObject samplePayload(samplePayloadRequest)
|
|
246
260
|
|
|
247
261
|
Builds the same payload shape used for serverless invocations and webhook delivery from a record and event type, without invoking anything.
|
|
248
262
|
|
|
@@ -277,7 +291,7 @@ const { status, data } = await apiInstance.samplePayload(
|
|
|
277
291
|
|
|
278
292
|
### Return type
|
|
279
293
|
|
|
280
|
-
**
|
|
294
|
+
**SuccessResponseObject**
|
|
281
295
|
|
|
282
296
|
### Authorization
|
|
283
297
|
|
|
@@ -295,11 +309,14 @@ const { status, data } = await apiInstance.samplePayload(
|
|
|
295
309
|
|**200** | Sample payload generated | - |
|
|
296
310
|
|**400** | Invalid input provided | - |
|
|
297
311
|
|**404** | App or record not found | - |
|
|
312
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
313
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
314
|
+
|**500** | An internal server error occurred. | - |
|
|
298
315
|
|
|
299
316
|
[[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)
|
|
300
317
|
|
|
301
318
|
# **show1**
|
|
302
|
-
>
|
|
319
|
+
> ShowResponseServerlessFunctionDTO show1()
|
|
303
320
|
|
|
304
321
|
Retrieves a serverless function by its UUID, ensuring it belongs to the specified app.
|
|
305
322
|
|
|
@@ -333,7 +350,7 @@ const { status, data } = await apiInstance.show1(
|
|
|
333
350
|
|
|
334
351
|
### Return type
|
|
335
352
|
|
|
336
|
-
**
|
|
353
|
+
**ShowResponseServerlessFunctionDTO**
|
|
337
354
|
|
|
338
355
|
### Authorization
|
|
339
356
|
|
|
@@ -350,11 +367,14 @@ const { status, data } = await apiInstance.show1(
|
|
|
350
367
|
|-------------|-------------|------------------|
|
|
351
368
|
|**200** | Successfully retrieved serverless function | - |
|
|
352
369
|
|**404** | Serverless function not found for this app | - |
|
|
370
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
371
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
372
|
+
|**500** | An internal server error occurred. | - |
|
|
353
373
|
|
|
354
374
|
[[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)
|
|
355
375
|
|
|
356
376
|
# **testServerlessFunction**
|
|
357
|
-
>
|
|
377
|
+
> SuccessResponseMapStringObject testServerlessFunction(testServerlessFunctionRequest)
|
|
358
378
|
|
|
359
379
|
Provisions (if needed) and invokes a serverless function for a given record and event type, using the same payload shape as webhooks.
|
|
360
380
|
|
|
@@ -392,7 +412,7 @@ const { status, data } = await apiInstance.testServerlessFunction(
|
|
|
392
412
|
|
|
393
413
|
### Return type
|
|
394
414
|
|
|
395
|
-
**
|
|
415
|
+
**SuccessResponseMapStringObject**
|
|
396
416
|
|
|
397
417
|
### Authorization
|
|
398
418
|
|
|
@@ -410,11 +430,14 @@ const { status, data } = await apiInstance.testServerlessFunction(
|
|
|
410
430
|
|**200** | Serverless function test executed | - |
|
|
411
431
|
|**400** | Invalid input provided | - |
|
|
412
432
|
|**404** | App, serverless function, or record not found | - |
|
|
433
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
434
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
435
|
+
|**500** | An internal server error occurred. | - |
|
|
413
436
|
|
|
414
437
|
[[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)
|
|
415
438
|
|
|
416
439
|
# **update1**
|
|
417
|
-
>
|
|
440
|
+
> ShowResponseServerlessFunctionDTO update1(serverlessFunctionDTO)
|
|
418
441
|
|
|
419
442
|
Updates an existing serverless function\'s runtime and code, keeping it attached to the same app.
|
|
420
443
|
|
|
@@ -452,7 +475,7 @@ const { status, data } = await apiInstance.update1(
|
|
|
452
475
|
|
|
453
476
|
### Return type
|
|
454
477
|
|
|
455
|
-
**
|
|
478
|
+
**ShowResponseServerlessFunctionDTO**
|
|
456
479
|
|
|
457
480
|
### Authorization
|
|
458
481
|
|
|
@@ -469,6 +492,9 @@ const { status, data } = await apiInstance.update1(
|
|
|
469
492
|
|-------------|-------------|------------------|
|
|
470
493
|
|**200** | Successfully updated serverless function | - |
|
|
471
494
|
|**404** | Serverless function not found for this app | - |
|
|
495
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
496
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
497
|
+
|**500** | An internal server error occurred. | - |
|
|
472
498
|
|
|
473
499
|
[[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)
|
|
474
500
|
|
package/docs/SettingField.md
CHANGED
|
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**hidden** | **boolean** | | [optional] [default to undefined]
|
|
15
15
|
**disabled** | **boolean** | | [optional] [default to undefined]
|
|
16
16
|
**_options** | [**Array<SettingOption>**](SettingOption.md) | | [optional] [default to undefined]
|
|
17
|
-
**value** | **any** | | [optional] [default to undefined]
|
|
18
17
|
**defaultValue** | **any** | | [optional] [default to undefined]
|
|
18
|
+
**value** | **any** | | [optional] [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -32,8 +32,8 @@ const instance: SettingField = {
|
|
|
32
32
|
hidden,
|
|
33
33
|
disabled,
|
|
34
34
|
_options,
|
|
35
|
-
value,
|
|
36
35
|
defaultValue,
|
|
36
|
+
value,
|
|
37
37
|
};
|
|
38
38
|
```
|
|
39
39
|
|
package/docs/ShowResponse.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# ShowResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Success response (ShowResponse).
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**message** | **string** |
|
|
10
|
-
**data** | **
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**data** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|