@caraer/client 2.0.381 → 2.0.382

package/docs/RecordsApi.md

@@ -5,20 +5,30 @@ All URIs are relative to *https://v2.api.caraer.com*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**_delete**](#_delete) | **DELETE** /api/v2/records/{uuid} | Delete a record|
+|[**aggregate**](#aggregate) | **POST** /api/v2/records/aggregate | Aggregate records for analytics charts|
+|[**aggregateBatch**](#aggregatebatch) | **POST** /api/v2/records/aggregate/batch | Batch aggregate records for analytics dashboards|
+|[**bulkDelete**](#bulkdelete) | **POST** /api/v2/records/{objectName}/bulk-delete | Bulk delete records|
+|[**bulkEdit**](#bulkedit) | **PUT** /api/v2/records/{objectName}/bulk | Bulk create or update records|
 |[**create**](#create) | **POST** /api/v2/records/{objectName} | Create a new record|
 |[**createOrUpdate**](#createorupdate) | **POST** /api/v2/records/{objectName}/createOrUpdate | Create or update a record|
 |[**createRelation**](#createrelation) | **POST** /api/v2/records/relations/{fromUuid}/{relationName}/{toUuid} | Create a relation between records|
 |[**deleteRelation**](#deleterelation) | **DELETE** /api/v2/records/relations/{fromUuid}/{relationName}/{toUuid} | Delete a relation between records|
+|[**extend**](#extend) | **POST** /api/v2/records/{uuid}/extend | Extend a record|
 |[**index**](#index) | **POST** /api/v2/records/index | Fetch paginated records|
 |[**indexFlow**](#indexflow) | **POST** /api/v2/records/index/flow | Fetch records for flow view|
 |[**indexPage**](#indexpage) | **POST** /api/v2/records/index/page | Fetch records for page view|
 |[**indexTable**](#indextable) | **POST** /api/v2/records/index/table | Fetch records for table view|
-|[**morph**](#morph) | **POST** /api/v2/records/{uuid}/morph | Morph a record|
 |[**preview**](#preview) | **GET** /api/v2/records/{uuid}/previews/{name} | Get record preview|
+|[**query**](#query) | **POST** /api/v2/records/query | Advanced graph-aware record query|
 |[**restore**](#restore) | **POST** /api/v2/records/{uuid}/restore | Restore a deleted record|
 |[**search**](#search) | **POST** /api/v2/records/search | Search records|
-|[**show1**](#show1) | **GET** /api/v2/records/{uuid} | Get record details|
+|[**searchCrossObject**](#searchcrossobject) | **POST** /api/v2/records/search/cross-object | Search records across objects|
+|[**show**](#show) | **GET** /api/v2/records/{uuid} | Get record details|
+|[**showByObject**](#showbyobject) | **GET** /api/v2/records/{objectName}/{uuid} | Get record details by object|
+|[**suggestAnalyticsWidgets**](#suggestanalyticswidgets) | **POST** /api/v2/records/analytics/suggest-widgets | Suggest analytics widgets with AI|
 |[**update**](#update) | **PUT** /api/v2/records/{objectName}/{uuid} | Update a record|
+|[**updateByUuid**](#updatebyuuid) | **PUT** /api/v2/records/{uuid} | Update a record by UUID|
+|[**updateRelationEdge**](#updaterelationedge) | **PATCH** /api/v2/records/relations/{fromUuid}/{relationName}/{toUuid} | Update relation edge properties|
 
 # **_delete**
 > SuccessResponse _delete()
@@ -76,6 +86,228 @@ const { status, data } = await apiInstance._delete(
 
 [[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)
 
+# **aggregate**
+> SuccessResponse aggregate(aggregateRequest)
+
+Groups Neo4j records by property or time bucket and returns series points with optional drilldown filters.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration,
+    AggregateRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let aggregateRequest: AggregateRequest; //
+
+const { status, data } = await apiInstance.aggregate(
+    aggregateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aggregateRequest** | **AggregateRequest**|  | |
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Aggregation completed |  -  |
+|**400** | Invalid request |  -  |
+
+[[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)
+
+# **aggregateBatch**
+> SuccessResponse aggregateBatch(aggregateBatchRequest)
+
+Runs multiple aggregation requests for dashboard widgets.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration,
+    AggregateBatchRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let aggregateBatchRequest: AggregateBatchRequest; //
+
+const { status, data } = await apiInstance.aggregateBatch(
+    aggregateBatchRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aggregateBatchRequest** | **AggregateBatchRequest**|  | |
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Batch aggregation completed |  -  |
+|**400** | Invalid request |  -  |
+
+[[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)
+
+# **bulkDelete**
+> BulkDeleteRecordsResponse bulkDelete(bulkDeleteRecordsRequest)
+
+Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration,
+    BulkDeleteRecordsRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let objectName: string; // (default to undefined)
+let bulkDeleteRecordsRequest: BulkDeleteRecordsRequest; //
+
+const { status, data } = await apiInstance.bulkDelete(
+    objectName,
+    bulkDeleteRecordsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bulkDeleteRecordsRequest** | **BulkDeleteRecordsRequest**|  | |
+| **objectName** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BulkDeleteRecordsResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Bulk delete completed (possibly with per-record errors) |  -  |
+|**400** | Invalid request |  -  |
+
+[[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)
+
+# **bulkEdit**
+> BulkEditRecordsResponse bulkEdit(bulkEditRecordsRequest)
+
+Creates or updates multiple records in one request. Returns HTTP 201 when every item succeeds (no per-record errors). Returns HTTP 200 when one or more items fail validation; successful items are still persisted and listed in data.records, with failures in errors.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration,
+    BulkEditRecordsRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let objectName: string; // (default to undefined)
+let bulkEditRecordsRequest: BulkEditRecordsRequest; //
+let ignoreErrors: boolean; //If \'true\', allows each save to proceed while ignoring certain non-critical validation errors, when supported. (optional) (default to false)
+
+const { status, data } = await apiInstance.bulkEdit(
+    objectName,
+    bulkEditRecordsRequest,
+    ignoreErrors
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bulkEditRecordsRequest** | **BulkEditRecordsRequest**|  | |
+| **objectName** | [**string**] |  | defaults to undefined|
+| **ignoreErrors** | [**boolean**] | If \'true\', allows each save to proceed while ignoring certain non-critical validation errors, when supported. | (optional) defaults to false|
+
+
+### Return type
+
+**BulkEditRecordsResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | All records saved successfully |  -  |
+|**200** | Partial success with per-record validation errors |  -  |
+|**400** | Invalid request |  -  |
+
+[[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)
+
 # **create**
 > CreateResponse create(recordDTO)
 
@@ -95,9 +327,9 @@ const apiInstance = new RecordsApi(configuration);
 
 let objectName: string; // (default to undefined)
 let recordDTO: RecordDTO; //Record data to create
-let parse: boolean; //If \'true\', parses the created record to human-readable values before returning. (optional) (default to false)
+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)
 let ignoreErrors: boolean; //If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported. (optional) (default to false)
-let recordReturnFormat: string; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
+let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
 
 const { status, data } = await apiInstance.create(
     objectName,
@@ -114,9 +346,9 @@ const { status, data } = await apiInstance.create(
 |------------- | ------------- | ------------- | -------------|
 | **recordDTO** | **RecordDTO**| Record data to create | |
 | **objectName** | [**string**] |  | defaults to undefined|
-| **parse** | [**boolean**] | If \'true\', parses the created record to human-readable values before returning. | (optional) defaults to false|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
 | **ignoreErrors** | [**boolean**] | If \&#39;true\&#39;, allows the creation to proceed while ignoring certain non-critical validation errors, when supported. | (optional) defaults to false|
-| **recordReturnFormat** | [**string**] | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
+| **recordReturnFormat** | [**&#39;LEGACY&#39; | &#39;USER_FRIENDLY&#39; | &#39;EXPANDED&#39;**]**Array<&#39;LEGACY&#39; &#124; &#39;USER_FRIENDLY&#39; &#124; &#39;EXPANDED&#39;>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
 
 
 ### Return type
@@ -161,9 +393,9 @@ const apiInstance = new RecordsApi(configuration);
 
 let objectName: string; // (default to undefined)
 let recordDTO: RecordDTO; //Record data to create or update
-let parse: boolean; // (optional) (default to false)
+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)
 let ignoreErrors: boolean; // (optional) (default to false)
-let recordReturnFormat: string; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
+let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
 
 const { status, data } = await apiInstance.createOrUpdate(
     objectName,
@@ -180,9 +412,9 @@ const { status, data } = await apiInstance.createOrUpdate(
 |------------- | ------------- | ------------- | -------------|
 | **recordDTO** | **RecordDTO**| Record data to create or update | |
 | **objectName** | [**string**] |  | defaults to undefined|
-| **parse** | [**boolean**] |  | (optional) defaults to false|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
 | **ignoreErrors** | [**boolean**] |  | (optional) defaults to false|
-| **recordReturnFormat** | [**string**] | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
+| **recordReturnFormat** | [**&#39;LEGACY&#39; | &#39;USER_FRIENDLY&#39; | &#39;EXPANDED&#39;**]**Array<&#39;LEGACY&#39; &#124; &#39;USER_FRIENDLY&#39; &#124; &#39;EXPANDED&#39;>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
 
 
 ### Return type
@@ -219,7 +451,8 @@ Creates a relation between two records identified by their UUIDs using the provi
 ```typescript
 import {
     RecordsApi,
-    Configuration
+    Configuration,
+    RelationEdgeRequestDTO
 } from '@caraer/client';
 
 const configuration = new Configuration();
@@ -229,12 +462,14 @@ let fromUuid: string; // (default to undefined)
 let relationName: string; // (default to undefined)
 let toUuid: string; // (default to undefined)
 let primary: object; //When \'true\', marks the created relation as primary. Defaults to \'false\'. (optional) (default to undefined)
+let relationEdgeRequestDTO: RelationEdgeRequestDTO; // (optional)
 
 const { status, data } = await apiInstance.createRelation(
     fromUuid,
     relationName,
     toUuid,
-    primary
+    primary,
+    relationEdgeRequestDTO
 );
 ```
 
@@ -242,6 +477,7 @@ const { status, data } = await apiInstance.createRelation(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **relationEdgeRequestDTO** | **RelationEdgeRequestDTO**|  | |
 | **fromUuid** | [**string**] |  | defaults to undefined|
 | **relationName** | [**string**] |  | defaults to undefined|
 | **toUuid** | [**string**] |  | defaults to undefined|
@@ -258,7 +494,7 @@ const { status, data } = await apiInstance.createRelation(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
@@ -330,6 +566,69 @@ const { status, data } = await apiInstance.deleteRelation(
 
 [[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)
 
+# **extend**
+> SuccessResponse extend(extendRecordRequest)
+
+Extends a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been extended.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration,
+    ExtendRecordRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let uuid: string; // (default to undefined)
+let extendRecordRequest: ExtendRecordRequest; //
+let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
+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)
+
+const { status, data } = await apiInstance.extend(
+    uuid,
+    extendRecordRequest,
+    recordReturnFormat,
+    parse
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **extendRecordRequest** | **ExtendRecordRequest**|  | |
+| **uuid** | [**string**] |  | defaults to undefined|
+| **recordReturnFormat** | [**&#39;LEGACY&#39; | &#39;USER_FRIENDLY&#39; | &#39;EXPANDED&#39;**]**Array<&#39;LEGACY&#39; &#124; &#39;USER_FRIENDLY&#39; &#124; &#39;EXPANDED&#39;>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Record extended successfully |  -  |
+|**404** | Record not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
 # **index**
 > PaginationResponse index(body)
 
@@ -347,10 +646,10 @@ const configuration = new Configuration();
 const apiInstance = new RecordsApi(configuration);
 
 let body: string; //Pagination request for records
-let parse: boolean; //If set to \'true\', records are parsed to human-readable values (for example, unix timestamps are formatted as dates). (optional) (default to undefined)
+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)
 let archived: boolean; //When \'true\', archived records are returned instead of active records. Defaults to \'false\'. (optional) (default to false)
 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)
-let recordReturnFormat: string; //Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
+let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
 
 const { status, data } = await apiInstance.index(
     body,
@@ -366,10 +665,10 @@ const { status, data } = await apiInstance.index(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **body** | **string**| Pagination request for records | |
-| **parse** | [**boolean**] | If set to \&#39;true\&#39;, records are parsed to human-readable values (for example, unix timestamps are formatted as dates). | (optional) defaults to undefined|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
 | **archived** | [**boolean**] | When \&#39;true\&#39;, archived records are returned instead of active records. Defaults to \&#39;false\&#39;. | (optional) defaults to false|
 | **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|
-| **recordReturnFormat** | [**string**] | Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
+| **recordReturnFormat** | [**&#39;LEGACY&#39; | &#39;USER_FRIENDLY&#39; | &#39;EXPANDED&#39;**]**Array<&#39;LEGACY&#39; &#124; &#39;USER_FRIENDLY&#39; &#124; &#39;EXPANDED&#39;>** | Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
 
 
 ### Return type
@@ -413,7 +712,7 @@ const apiInstance = new RecordsApi(configuration);
 
 let body: string; //Pagination request for flow view
 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)
-let parse: boolean; //Whether to parse the record before returning it. (optional) (default to undefined)
+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)
 
 const { status, data } = await apiInstance.indexFlow(
     body,
@@ -428,7 +727,7 @@ const { status, data } = await apiInstance.indexFlow(
 |------------- | ------------- | ------------- | -------------|
 | **body** | **string**| Pagination request for flow view | |
 | **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|
-| **parse** | [**boolean**] | Whether to parse the record before returning it. | (optional) defaults to undefined|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
 
 
 ### Return type
@@ -576,32 +875,31 @@ const { status, data } = await apiInstance.indexTable(
 
 [[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)
 
-# **morph**
-> SuccessResponse morph(morphRecordRequest)
+# **preview**
+> ShowResponse preview()
 
-Morphs a record identified by its UUID to one or more objects. You can use this to move a record or add it to another object so it\'ll be visible in the new object.Returns a SuccessResponse confirming that the record has been morphed.
+Retrieves a preview for a record specified by its UUID and preview name. Returns a ShowResponse containing the preview data.
 
 ### Example
 
 ```typescript
 import {
     RecordsApi,
-    Configuration,
-    MorphRecordRequest
+    Configuration
 } from '@caraer/client';
 
 const configuration = new Configuration();
 const apiInstance = new RecordsApi(configuration);
 
 let uuid: string; // (default to undefined)
-let morphRecordRequest: MorphRecordRequest; //
-let recordReturnFormat: string; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
-let parse: boolean; //Whether to parse the record before returning it. (optional) (default to undefined)
+let name: string; // (default to undefined)
+let object: string; //Optional object name used to resolve the record before building the preview. (optional) (default to undefined)
+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)
 
-const { status, data } = await apiInstance.morph(
+const { status, data } = await apiInstance.preview(
     uuid,
-    morphRecordRequest,
-    recordReturnFormat,
+    name,
+    object,
     parse
 );
 ```
@@ -610,15 +908,15 @@ const { status, data } = await apiInstance.morph(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **morphRecordRequest** | **MorphRecordRequest**|  | |
 | **uuid** | [**string**] |  | defaults to undefined|
-| **recordReturnFormat** | [**string**] | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
-| **parse** | [**boolean**] | Whether to parse the record before returning it. | (optional) defaults to undefined|
+| **name** | [**string**] |  | defaults to undefined|
+| **object** | [**string**] | Optional object name used to resolve the record before building the preview. | (optional) defaults to undefined|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
 
 
 ### Return type
 
-**SuccessResponse**
+**ShowResponse**
 
 ### Authorization
 
@@ -626,45 +924,39 @@ const { status, data } = await apiInstance.morph(
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Record morphed successfully |  -  |
-|**404** | Record not found |  -  |
-|**500** | Internal server error |  -  |
+|**200** | Preview retrieved successfully |  -  |
+|**404** | Record or preview not found |  -  |
 
 [[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)
 
-# **preview**
-> ShowResponse preview()
+# **query**
+> AdvancedRecordQueryResponse query(advancedRecordQueryRequest)
 
-Retrieves a preview for a record specified by its UUID and preview name. Returns a ShowResponse containing the preview data.
+Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence.
 
 ### Example
 
 ```typescript
 import {
     RecordsApi,
-    Configuration
+    Configuration,
+    AdvancedRecordQueryRequest
 } from '@caraer/client';
 
 const configuration = new Configuration();
 const apiInstance = new RecordsApi(configuration);
 
-let uuid: string; // (default to undefined)
-let name: string; // (default to undefined)
-let object: string; //Optional object name used to resolve the record before building the preview. (optional) (default to undefined)
-let parse: boolean; //Whether to parse the record before returning it. (optional) (default to undefined)
+let advancedRecordQueryRequest: AdvancedRecordQueryRequest; //
 
-const { status, data } = await apiInstance.preview(
-    uuid,
-    name,
-    object,
-    parse
+const { status, data } = await apiInstance.query(
+    advancedRecordQueryRequest
 );
 ```
 
@@ -672,15 +964,12 @@ const { status, data } = await apiInstance.preview(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **uuid** | [**string**] |  | defaults to undefined|
-| **name** | [**string**] |  | defaults to undefined|
-| **object** | [**string**] | Optional object name used to resolve the record before building the preview. | (optional) defaults to undefined|
-| **parse** | [**boolean**] | Whether to parse the record before returning it. | (optional) defaults to undefined|
+| **advancedRecordQueryRequest** | **AdvancedRecordQueryRequest**|  | |
 
 
 ### Return type
 
-**ShowResponse**
+**AdvancedRecordQueryResponse**
 
 ### Authorization
 
@@ -688,15 +977,15 @@ const { status, data } = await apiInstance.preview(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Preview retrieved successfully |  -  |
-|**404** | Record or preview not found |  -  |
+|**200** | Query completed successfully |  -  |
+|**400** | Invalid query request |  -  |
 
 [[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)
 
@@ -771,8 +1060,8 @@ const apiInstance = new RecordsApi(configuration);
 
 let body: string; //Search criteria
 let archived: boolean; //When set to \'true\', includes soft-deleted records in the search results. (optional) (default to false)
-let parse: boolean; //If \'true\', parses returned records to human-readable values. (optional) (default to false)
-let recordReturnFormat: string; //Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
+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)
+let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
 
 const { status, data } = await apiInstance.search(
     body,
@@ -788,8 +1077,8 @@ const { status, data } = await apiInstance.search(
 |------------- | ------------- | ------------- | -------------|
 | **body** | **string**| Search criteria | |
 | **archived** | [**boolean**] | When set to \&#39;true\&#39;, includes soft-deleted records in the search results. | (optional) defaults to false|
-| **parse** | [**boolean**] | If \&#39;true\&#39;, parses returned records to human-readable values. | (optional) defaults to false|
-| **recordReturnFormat** | [**string**] | Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
+| **recordReturnFormat** | [**&#39;LEGACY&#39; | &#39;USER_FRIENDLY&#39; | &#39;EXPANDED&#39;**]**Array<&#39;LEGACY&#39; &#124; &#39;USER_FRIENDLY&#39; &#124; &#39;EXPANDED&#39;>** | Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
 
 
 ### Return type
@@ -815,10 +1104,69 @@ const { status, data } = await apiInstance.search(
 
 [[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)
 
-# **show1**
-> ShowResponse show1()
+# **searchCrossObject**
+> PaginationResponse searchCrossObject(crossObjectRecordSearchRequest)
+
+Searches records across multiple object types in one request. Use fromObjectUuid + relationName to limit to relation target objects (e.g. event attendees), or objectUuids for an explicit list, or omit both to search all company objects (capped). Returns preview-shaped results suitable for relation pickers.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration,
+    CrossObjectRecordSearchRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let crossObjectRecordSearchRequest: CrossObjectRecordSearchRequest; //
+let archived: boolean; //When true, includes archived records. (optional) (default to false)
+let parse: 'DB' | 'HUMAN_READABLE' | 'STRUCTURED'; //Parse property values for display. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.searchCrossObject(
+    crossObjectRecordSearchRequest,
+    archived,
+    parse
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **crossObjectRecordSearchRequest** | **CrossObjectRecordSearchRequest**|  | |
+| **archived** | [**boolean**] | When true, includes archived records. | (optional) defaults to false|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | Parse property values for display. | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginationResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Search completed successfully |  -  |
+|**400** | Invalid search parameters |  -  |
+
+[[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)
+
+# **show**
+> ShowResponse show()
 
-Retrieves detailed information about a record by its UUID. Returns a ShowResponse containing the record details.
+Retrieves detailed information about a record by its UUID. Returns a ShowResponse containing the record details. Prefer GET /{objectName}/{uuid} when the object context is known.
 
 ### Example
 
@@ -833,11 +1181,11 @@ const apiInstance = new RecordsApi(configuration);
 
 let uuid: string; // (default to undefined)
 let object: string; //Optional object name to resolve the record in a specific object context. (optional) (default to undefined)
-let recordReturnFormat: string; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
-let parse: boolean; //Whether to parse the record before returning it. (optional) (default to undefined)
+let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
+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)
 let fields: string; //Comma-separated property names to include (for example: name,status). When omitted, all properties are returned. (optional) (default to undefined)
 
-const { status, data } = await apiInstance.show1(
+const { status, data } = await apiInstance.show(
     uuid,
     object,
     recordReturnFormat,
@@ -852,8 +1200,8 @@ const { status, data } = await apiInstance.show1(
 |------------- | ------------- | ------------- | -------------|
 | **uuid** | [**string**] |  | defaults to undefined|
 | **object** | [**string**] | Optional object name to resolve the record in a specific object context. | (optional) defaults to undefined|
-| **recordReturnFormat** | [**string**] | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
-| **parse** | [**boolean**] | Whether to parse the record before returning it. | (optional) defaults to undefined|
+| **recordReturnFormat** | [**&#39;LEGACY&#39; | &#39;USER_FRIENDLY&#39; | &#39;EXPANDED&#39;**]**Array<&#39;LEGACY&#39; &#124; &#39;USER_FRIENDLY&#39; &#124; &#39;EXPANDED&#39;>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
 | **fields** | [**string**] | Comma-separated property names to include (for example: name,status). When omitted, all properties are returned. | (optional) defaults to undefined|
 
 
@@ -879,6 +1227,121 @@ const { status, data } = await apiInstance.show1(
 
 [[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)
 
+# **showByObject**
+> ShowResponse showByObject()
+
+Retrieves a record by object name and UUID. Same response as GET /{uuid}?object={objectName}.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let objectName: string; // (default to undefined)
+let uuid: string; // (default to undefined)
+let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
+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)
+
+const { status, data } = await apiInstance.showByObject(
+    objectName,
+    uuid,
+    recordReturnFormat,
+    parse
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectName** | [**string**] |  | defaults to undefined|
+| **uuid** | [**string**] |  | defaults to undefined|
+| **recordReturnFormat** | [**&#39;LEGACY&#39; | &#39;USER_FRIENDLY&#39; | &#39;EXPANDED&#39;**]**Array<&#39;LEGACY&#39; &#124; &#39;USER_FRIENDLY&#39; &#124; &#39;EXPANDED&#39;>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
+
+
+### Return type
+
+**ShowResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Record retrieved successfully |  -  |
+|**404** | Record not found |  -  |
+
+[[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)
+
+# **suggestAnalyticsWidgets**
+> SuccessResponse suggestAnalyticsWidgets(suggestAnalyticsWidgetsRequest)
+
+Uses structured OpenAI output plus schema validation to propose dashboard charts for an object. Returns an empty list when AI is unavailable.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration,
+    SuggestAnalyticsWidgetsRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let suggestAnalyticsWidgetsRequest: SuggestAnalyticsWidgetsRequest; //
+
+const { status, data } = await apiInstance.suggestAnalyticsWidgets(
+    suggestAnalyticsWidgetsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **suggestAnalyticsWidgetsRequest** | **SuggestAnalyticsWidgetsRequest**|  | |
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Suggestions generated (may be empty) |  -  |
+|**400** | Invalid request |  -  |
+|**404** | Object not found |  -  |
+
+[[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)
+
 # **update**
 > UpdateResponse update(recordDTO)
 
@@ -899,9 +1362,9 @@ const apiInstance = new RecordsApi(configuration);
 let uuid: string; // (default to undefined)
 let objectName: string; // (default to undefined)
 let recordDTO: RecordDTO; //Record data to update
-let parse: boolean; //If \'true\', parses the updated record to human-readable values before returning. (optional) (default to false)
+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)
 let ignoreErrors: boolean; //If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. (optional) (default to false)
-let recordReturnFormat: string; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
+let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
 
 const { status, data } = await apiInstance.update(
     uuid,
@@ -920,9 +1383,79 @@ const { status, data } = await apiInstance.update(
 | **recordDTO** | **RecordDTO**| Record data to update | |
 | **uuid** | [**string**] |  | defaults to undefined|
 | **objectName** | [**string**] |  | defaults to undefined|
-| **parse** | [**boolean**] | If \&#39;true\&#39;, parses the updated record to human-readable values before returning. | (optional) defaults to false|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
+| **ignoreErrors** | [**boolean**] | If \&#39;true\&#39;, allows the update to proceed while ignoring certain non-critical validation errors, when supported. | (optional) defaults to false|
+| **recordReturnFormat** | [**&#39;LEGACY&#39; | &#39;USER_FRIENDLY&#39; | &#39;EXPANDED&#39;**]**Array<&#39;LEGACY&#39; &#124; &#39;USER_FRIENDLY&#39; &#124; &#39;EXPANDED&#39;>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
+
+
+### Return type
+
+**UpdateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Record updated successfully |  -  |
+|**400** | Invalid input data |  -  |
+|**404** | Record not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **updateByUuid**
+> UpdateResponse updateByUuid(recordDTO)
+
+Updates a record identified by UUID. Optional object query param resolves the object context (same as GET /{uuid}?object=...). When omitted, the record\'s current/primary object is used. Prefer PUT /{objectName}/{uuid} when the object context is known.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration,
+    RecordDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let uuid: string; // (default to undefined)
+let recordDTO: RecordDTO; //
+let object: string; //Optional object name to resolve the record in a specific object context. (optional) (default to undefined)
+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)
+let ignoreErrors: boolean; //If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported. (optional) (default to false)
+let recordReturnFormat: 'LEGACY' | 'USER_FRIENDLY' | 'EXPANDED'; //Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. (optional) (default to 'LEGACY')
+
+const { status, data } = await apiInstance.updateByUuid(
+    uuid,
+    recordDTO,
+    object,
+    parse,
+    ignoreErrors,
+    recordReturnFormat
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **recordDTO** | **RecordDTO**|  | |
+| **uuid** | [**string**] |  | defaults to undefined|
+| **object** | [**string**] | Optional object name to resolve the record in a specific object context. | (optional) defaults to undefined|
+| **parse** | [**&#39;DB&#39; | &#39;HUMAN_READABLE&#39; | &#39;STRUCTURED&#39;**]**Array<&#39;DB&#39; &#124; &#39;HUMAN_READABLE&#39; &#124; &#39;STRUCTURED&#39;>** | 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|
 | **ignoreErrors** | [**boolean**] | If \&#39;true\&#39;, allows the update to proceed while ignoring certain non-critical validation errors, when supported. | (optional) defaults to false|
-| **recordReturnFormat** | [**string**] | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
+| **recordReturnFormat** | [**&#39;LEGACY&#39; | &#39;USER_FRIENDLY&#39; | &#39;EXPANDED&#39;**]**Array<&#39;LEGACY&#39; &#124; &#39;USER_FRIENDLY&#39; &#124; &#39;EXPANDED&#39;>** | Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED. | (optional) defaults to 'LEGACY'|
 
 
 ### Return type
@@ -949,3 +1482,66 @@ const { status, data } = await apiInstance.update(
 
 [[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)
 
+# **updateRelationEdge**
+> SuccessResponse updateRelationEdge(relationEdgeRequestDTO)
+
+Patches values stored on an existing relation edge. Only keys present in edgeProperties are written; a null value clears a key.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration,
+    RelationEdgeRequestDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let fromUuid: string; // (default to undefined)
+let relationName: string; // (default to undefined)
+let toUuid: string; // (default to undefined)
+let relationEdgeRequestDTO: RelationEdgeRequestDTO; //
+
+const { status, data } = await apiInstance.updateRelationEdge(
+    fromUuid,
+    relationName,
+    toUuid,
+    relationEdgeRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **relationEdgeRequestDTO** | **RelationEdgeRequestDTO**|  | |
+| **fromUuid** | [**string**] |  | defaults to undefined|
+| **relationName** | [**string**] |  | defaults to undefined|
+| **toUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Relation updated successfully |  -  |
+|**400** | Unknown or invalid edge property |  -  |
+|**404** | One or more entities not found |  -  |
+
+[[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)
+