@caraer/client 2.0.610 → 2.0.618
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/api.ts +145 -40
- package/dist/api.d.ts +93 -40
- package/dist/api.js +132 -36
- package/dist/esm/api.d.ts +93 -40
- package/dist/esm/api.js +132 -36
- package/docs/CMSV2PublicApi.md +62 -0
- package/docs/ExistingWidgetSummary.md +4 -4
- package/docs/Record.md +2 -2
- package/docs/RecordsApi.md +18 -18
- package/docs/SubscribeWebhookDTO.md +3 -1
- package/package.json +1 -1
package/docs/RecordsApi.md
CHANGED
|
@@ -347,7 +347,7 @@ let objectName: string; // (default to undefined)
|
|
|
347
347
|
let recordDTO: RecordDTO; //Record data to create
|
|
348
348
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). (optional) (default to undefined)
|
|
349
349
|
let ignoreErrors: boolean; //If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported. (optional) (default to false)
|
|
350
|
-
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
|
|
350
|
+
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
351
351
|
|
|
352
352
|
const { status, data } = await apiInstance.create(
|
|
353
353
|
objectName,
|
|
@@ -366,7 +366,7 @@ const { status, data } = await apiInstance.create(
|
|
|
366
366
|
| **objectName** | [**string**] | | defaults to undefined|
|
|
367
367
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). | (optional) defaults to undefined|
|
|
368
368
|
| **ignoreErrors** | [**boolean**] | If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported. | (optional) defaults to false|
|
|
369
|
-
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
|
|
369
|
+
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. | (optional) defaults to 'LEGACY'|
|
|
370
370
|
|
|
371
371
|
|
|
372
372
|
### Return type
|
|
@@ -416,7 +416,7 @@ let objectName: string; // (default to undefined)
|
|
|
416
416
|
let recordDTO: RecordDTO; //Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
417
417
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). (optional) (default to undefined)
|
|
418
418
|
let ignoreErrors: boolean; // (optional) (default to false)
|
|
419
|
-
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
|
|
419
|
+
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
420
420
|
|
|
421
421
|
const { status, data } = await apiInstance.createOrUpdate(
|
|
422
422
|
objectName,
|
|
@@ -435,7 +435,7 @@ const { status, data } = await apiInstance.createOrUpdate(
|
|
|
435
435
|
| **objectName** | [**string**] | | defaults to undefined|
|
|
436
436
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). | (optional) defaults to undefined|
|
|
437
437
|
| **ignoreErrors** | [**boolean**] | | (optional) defaults to false|
|
|
438
|
-
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
|
|
438
|
+
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. | (optional) defaults to 'LEGACY'|
|
|
439
439
|
|
|
440
440
|
|
|
441
441
|
### Return type
|
|
@@ -613,7 +613,7 @@ const apiInstance = new RecordsApi(configuration);
|
|
|
613
613
|
|
|
614
614
|
let uuid: string; // (default to undefined)
|
|
615
615
|
let extendRecordRequest: ExtendRecordRequest; //
|
|
616
|
-
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
|
|
616
|
+
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
617
617
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). (optional) (default to undefined)
|
|
618
618
|
|
|
619
619
|
const { status, data } = await apiInstance.extend(
|
|
@@ -630,7 +630,7 @@ const { status, data } = await apiInstance.extend(
|
|
|
630
630
|
|------------- | ------------- | ------------- | -------------|
|
|
631
631
|
| **extendRecordRequest** | **ExtendRecordRequest**| | |
|
|
632
632
|
| **uuid** | [**string**] | | defaults to undefined|
|
|
633
|
-
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
|
|
633
|
+
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. | (optional) defaults to 'LEGACY'|
|
|
634
634
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). | (optional) defaults to undefined|
|
|
635
635
|
|
|
636
636
|
|
|
@@ -680,7 +680,7 @@ let recordPaginationRequest: RecordPaginationRequest; //Pagination request for r
|
|
|
680
680
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). (optional) (default to undefined)
|
|
681
681
|
let archived: boolean; //When \'true\', archived records are returned instead of active records. Defaults to \'false\'. (optional) (default to false)
|
|
682
682
|
let relatedRecordUuid: string; //UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. (optional) (default to undefined)
|
|
683
|
-
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
|
|
683
|
+
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
684
684
|
|
|
685
685
|
const { status, data } = await apiInstance.index(
|
|
686
686
|
recordPaginationRequest,
|
|
@@ -699,7 +699,7 @@ const { status, data } = await apiInstance.index(
|
|
|
699
699
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). | (optional) defaults to undefined|
|
|
700
700
|
| **archived** | [**boolean**] | When \'true\', archived records are returned instead of active records. Defaults to \'false\'. | (optional) defaults to false|
|
|
701
701
|
| **relatedRecordUuid** | [**string**] | UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record. | (optional) defaults to undefined|
|
|
702
|
-
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'>** | Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
|
|
702
|
+
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'>** | Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. | (optional) defaults to 'LEGACY'|
|
|
703
703
|
|
|
704
704
|
|
|
705
705
|
### Return type
|
|
@@ -1119,7 +1119,7 @@ const apiInstance = new RecordsApi(configuration);
|
|
|
1119
1119
|
let searchRequest: SearchRequest; //Search criteria
|
|
1120
1120
|
let archived: boolean; //When set to \'true\', includes soft-deleted records in the search results. (optional) (default to false)
|
|
1121
1121
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). (optional) (default to undefined)
|
|
1122
|
-
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
|
|
1122
|
+
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
1123
1123
|
|
|
1124
1124
|
const { status, data } = await apiInstance.search(
|
|
1125
1125
|
searchRequest,
|
|
@@ -1136,7 +1136,7 @@ const { status, data } = await apiInstance.search(
|
|
|
1136
1136
|
| **searchRequest** | **SearchRequest**| Search criteria | |
|
|
1137
1137
|
| **archived** | [**boolean**] | When set to \'true\', includes soft-deleted records in the search results. | (optional) defaults to false|
|
|
1138
1138
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). | (optional) defaults to undefined|
|
|
1139
|
-
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'>** | Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
|
|
1139
|
+
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'>** | Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. | (optional) defaults to 'LEGACY'|
|
|
1140
1140
|
|
|
1141
1141
|
|
|
1142
1142
|
### Return type
|
|
@@ -1246,7 +1246,7 @@ const apiInstance = new RecordsApi(configuration);
|
|
|
1246
1246
|
|
|
1247
1247
|
let uuid: string; // (default to undefined)
|
|
1248
1248
|
let object: string; //Optional object name to resolve the record in a specific object context. (optional) (default to undefined)
|
|
1249
|
-
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
|
|
1249
|
+
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
1250
1250
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). (optional) (default to undefined)
|
|
1251
1251
|
let fields: string; //Comma-separated property names to include (for example: name,status). When omitted, all properties are returned. (optional) (default to undefined)
|
|
1252
1252
|
|
|
@@ -1265,7 +1265,7 @@ const { status, data } = await apiInstance.show(
|
|
|
1265
1265
|
|------------- | ------------- | ------------- | -------------|
|
|
1266
1266
|
| **uuid** | [**string**] | | defaults to undefined|
|
|
1267
1267
|
| **object** | [**string**] | Optional object name to resolve the record in a specific object context. | (optional) defaults to undefined|
|
|
1268
|
-
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
|
|
1268
|
+
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. | (optional) defaults to 'LEGACY'|
|
|
1269
1269
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). | (optional) defaults to undefined|
|
|
1270
1270
|
| **fields** | [**string**] | Comma-separated property names to include (for example: name,status). When omitted, all properties are returned. | (optional) defaults to undefined|
|
|
1271
1271
|
|
|
@@ -1313,7 +1313,7 @@ const apiInstance = new RecordsApi(configuration);
|
|
|
1313
1313
|
|
|
1314
1314
|
let objectName: string; // (default to undefined)
|
|
1315
1315
|
let uuid: string; // (default to undefined)
|
|
1316
|
-
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
|
|
1316
|
+
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
1317
1317
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). (optional) (default to undefined)
|
|
1318
1318
|
|
|
1319
1319
|
const { status, data } = await apiInstance.showByObject(
|
|
@@ -1330,7 +1330,7 @@ const { status, data } = await apiInstance.showByObject(
|
|
|
1330
1330
|
|------------- | ------------- | ------------- | -------------|
|
|
1331
1331
|
| **objectName** | [**string**] | | defaults to undefined|
|
|
1332
1332
|
| **uuid** | [**string**] | | defaults to undefined|
|
|
1333
|
-
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
|
|
1333
|
+
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. | (optional) defaults to 'LEGACY'|
|
|
1334
1334
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). | (optional) defaults to undefined|
|
|
1335
1335
|
|
|
1336
1336
|
|
|
@@ -1438,7 +1438,7 @@ let objectName: string; // (default to undefined)
|
|
|
1438
1438
|
let recordDTO: RecordDTO; //Record data to update
|
|
1439
1439
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). (optional) (default to undefined)
|
|
1440
1440
|
let ignoreErrors: boolean; //If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. (optional) (default to false)
|
|
1441
|
-
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
|
|
1441
|
+
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
1442
1442
|
|
|
1443
1443
|
const { status, data } = await apiInstance.update(
|
|
1444
1444
|
uuid,
|
|
@@ -1459,7 +1459,7 @@ const { status, data } = await apiInstance.update(
|
|
|
1459
1459
|
| **objectName** | [**string**] | | defaults to undefined|
|
|
1460
1460
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). | (optional) defaults to undefined|
|
|
1461
1461
|
| **ignoreErrors** | [**boolean**] | If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. | (optional) defaults to false|
|
|
1462
|
-
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
|
|
1462
|
+
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. | (optional) defaults to 'LEGACY'|
|
|
1463
1463
|
|
|
1464
1464
|
|
|
1465
1465
|
### Return type
|
|
@@ -1510,7 +1510,7 @@ let recordDTO: RecordDTO; //
|
|
|
1510
1510
|
let object: string; //Optional object name to resolve the record in a specific object context. (optional) (default to undefined)
|
|
1511
1511
|
let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). (optional) (default to undefined)
|
|
1512
1512
|
let ignoreErrors: boolean; //If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. (optional) (default to false)
|
|
1513
|
-
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
|
|
1513
|
+
let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. (optional) (default to 'LEGACY')
|
|
1514
1514
|
|
|
1515
1515
|
const { status, data } = await apiInstance.updateByUuid(
|
|
1516
1516
|
uuid,
|
|
@@ -1531,7 +1531,7 @@ const { status, data } = await apiInstance.updateByUuid(
|
|
|
1531
1531
|
| **object** | [**string**] | Optional object name to resolve the record in a specific object context. | (optional) defaults to undefined|
|
|
1532
1532
|
| **parse** | [**'DB' | 'HUMAN_READABLE' | 'STRUCTURED'**]**Array<'DB' | 'HUMAN_READABLE' | 'STRUCTURED'>** | Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records). | (optional) defaults to undefined|
|
|
1533
1533
|
| **ignoreErrors** | [**boolean**] | If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. | (optional) defaults to false|
|
|
1534
|
-
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
|
|
1534
|
+
| **recordReturnFormat** | [**'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'**]**Array<'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED' | 'MINIMAL'>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL. | (optional) defaults to 'LEGACY'|
|
|
1535
1535
|
|
|
1536
1536
|
|
|
1537
1537
|
### Return type
|
|
@@ -13,9 +13,10 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**secret** | **string** | The secret used for webhook validation. | [optional] [default to undefined]
|
|
14
14
|
**topic** | **string** | The topic for which the webhook is subscribed. | [optional] [default to undefined]
|
|
15
15
|
**description** | **string** | Optional human-readable description for this webhook | [optional] [default to undefined]
|
|
16
|
-
**webhookFormat** | **string** | Webhook payload format (LEGACY, USER_FRIENDLY) | [optional] [default to undefined]
|
|
16
|
+
**webhookFormat** | **string** | Webhook payload format (LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL) | [optional] [default to undefined]
|
|
17
17
|
**parseRecord** | **boolean** | Whether to parse the record before returning it | [optional] [default to undefined]
|
|
18
18
|
**filter** | [**Filter**](Filter.md) | Filter criteria for webhook triggers | [optional] [default to undefined]
|
|
19
|
+
**fields** | **string** | Comma-separated property names to include on the main record. Omitted or blank returns all readable properties; record identity is always included. | [optional] [default to undefined]
|
|
19
20
|
**includeRelations** | **Array<string>** | Records to include in webhook payload | [optional] [default to undefined]
|
|
20
21
|
**relationFilters** | [**{ [key: string]: Filter; }**](Filter.md) | Filter criteria for relations | [optional] [default to undefined]
|
|
21
22
|
**relationLimit** | **number** | Maximum number of relations to include | [optional] [default to undefined]
|
|
@@ -54,6 +55,7 @@ const instance: SubscribeWebhookDTO = {
|
|
|
54
55
|
webhookFormat,
|
|
55
56
|
parseRecord,
|
|
56
57
|
filter,
|
|
58
|
+
fields,
|
|
57
59
|
includeRelations,
|
|
58
60
|
relationFilters,
|
|
59
61
|
relationLimit,
|