@caraer/client 2.0.381 → 2.0.382
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 +72 -1
- package/api.ts +7888 -2480
- package/apps.ts +122 -0
- package/dist/api.d.ts +3806 -637
- package/dist/api.js +6088 -1935
- package/dist/apps.d.ts +111 -0
- package/dist/apps.js +9 -0
- package/dist/esm/api.d.ts +3806 -637
- package/dist/esm/api.js +6019 -1883
- package/dist/esm/apps.d.ts +111 -0
- package/dist/esm/apps.js +8 -0
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/docs/AdvancedRecordQueryPlan.md +50 -0
- package/docs/AdvancedRecordQueryRequest.md +43 -0
- package/docs/AdvancedRecordQueryResponse.md +39 -0
- package/docs/AdvancedRecordQueryResultItem.md +32 -0
- package/docs/AggregateBatchRequest.md +21 -0
- package/docs/AggregateRequest.md +43 -0
- package/docs/AnalyticsAxisConfig.md +32 -0
- package/docs/AnalyticsComparisonMetric.md +28 -0
- package/docs/AnalyticsDashboardConfig.md +24 -0
- package/docs/AnalyticsPropertyRef.md +24 -0
- package/docs/AnalyticsReferenceLine.md +24 -0
- package/docs/AnalyticsSeriesConfig.md +20 -0
- package/docs/AnalyticsTrendConfig.md +22 -0
- package/docs/AnalyticsWidgetConfig.md +54 -0
- package/docs/AnalyticsWidgetStyle.md +32 -0
- package/docs/AppConnectionStatusDTO.md +38 -0
- package/docs/AppDTO.md +19 -1
- package/docs/AppExternalOAuthProviderDTO.md +59 -0
- package/docs/AppExternalOAuthProviderSummaryDTO.md +27 -0
- package/docs/AppInboundRouteDTO.md +49 -0
- package/docs/AppInstallationRuntimeApi.md +764 -0
- package/docs/AppOAuthStartResponseDTO.md +20 -0
- package/docs/AppPublishDTO.md +1 -1
- package/docs/AppScheduleDTO.md +47 -0
- package/docs/AppSettingFieldSchema.md +4 -0
- package/docs/AppSettingOptionsSource.md +2 -0
- package/docs/ApplicationsApi.md +228 -0
- package/docs/BillingApi.md +101 -0
- package/docs/BulkDeleteRecordsData.md +21 -0
- package/docs/BulkDeleteRecordsRequest.md +23 -0
- package/docs/BulkDeleteRecordsResponse.md +25 -0
- package/docs/BulkEditRecordErrorItem.md +27 -0
- package/docs/BulkEditRecordItem.md +25 -0
- package/docs/BulkEditRecordResultItem.md +25 -0
- package/docs/BulkEditRecordsData.md +21 -0
- package/docs/BulkEditRecordsRequest.md +21 -0
- package/docs/BulkEditRecordsResponse.md +25 -0
- package/docs/CompanyApi.md +157 -0
- package/docs/CreateDeveloperProjectRequest.md +25 -0
- package/docs/CreateDeveloperSandboxRequest.md +23 -0
- package/docs/CreatePrivateAppRequest.md +4 -0
- package/docs/CreateProjectBuildRequest.md +29 -0
- package/docs/CreateResponseAppExternalOAuthProviderDTO.md +23 -0
- package/docs/CreateResponseAppInboundRouteDTO.md +23 -0
- package/docs/CreateResponseAppScheduleDTO.md +23 -0
- package/docs/CriterionScore.md +30 -0
- package/docs/CrossObjectRecordSearchRequest.md +37 -0
- package/docs/DeleteResponseVoid.md +23 -0
- package/docs/DeployBuildRequest.md +23 -0
- package/docs/DeveloperProjectsApi.md +387 -0
- package/docs/DeveloperSandboxesApi.md +158 -0
- package/docs/DeviceApproveRequest.md +21 -0
- package/docs/DevicePollRequest.md +21 -0
- package/docs/ErrorResponse.md +2 -0
- package/docs/EventRsvpRequest.md +22 -0
- package/docs/ExistingWidgetSummary.md +34 -0
- package/docs/{MorphRecordRequest.md → ExtendRecordRequest.md} +5 -5
- package/docs/FilterItem.md +4 -0
- package/docs/GraphPathEvidence.md +28 -0
- package/docs/GraphTraversalSpec.md +32 -0
- package/docs/Leadscore.md +4 -0
- package/docs/MigrateAppToV2Request.md +21 -0
- package/docs/ObjectsApi.md +6 -6
- package/docs/PreviewDTO.md +2 -0
- package/docs/Progress.md +20 -0
- package/docs/PropertyDTO.md +4 -0
- package/docs/PropertyDTOFormat.md +2 -0
- package/docs/PropertyOption.md +2 -0
- package/docs/QueryEvidence.md +40 -0
- package/docs/Record.md +2 -2
- package/docs/RecordDTO.md +1 -1
- package/docs/RecordRelationRequestDTO.md +2 -0
- package/docs/RecordsApi.md +671 -75
- package/docs/Recurrence.md +18 -0
- package/docs/RefreshTokenRequest.md +21 -0
- package/docs/RelationEdgeRequestDTO.md +23 -0
- package/docs/SamplePayloadRequest.md +23 -0
- package/docs/SavePropertyDTO.md +5 -1
- package/docs/ScoreBreakdown.md +34 -0
- package/docs/ServerlessFunctionDTO.md +2 -0
- package/docs/ServerlessFunctionRefDTO.md +25 -0
- package/docs/ServerlessFunctionsApi.md +184 -8
- package/docs/ShowItem.md +2 -0
- package/docs/ShowResponseAppExternalOAuthProviderDTO.md +23 -0
- package/docs/ShowResponseAppInboundRouteDTO.md +23 -0
- package/docs/ShowResponseAppOAuthStartResponseDTO.md +23 -0
- package/docs/ShowResponseAppScheduleDTO.md +23 -0
- package/docs/ShowResponseListAppConnectionStatusDTO.md +23 -0
- package/docs/ShowResponseListString.md +23 -0
- package/docs/ShowResponseMapStringObject.md +23 -0
- package/docs/ShowResponseObject.md +23 -0
- package/docs/SortItem.md +2 -0
- package/docs/SuccessResponseListAppExternalOAuthProviderDTO.md +23 -0
- package/docs/SuccessResponseListAppInboundRouteDTO.md +23 -0
- package/docs/SuccessResponseListAppScheduleDTO.md +23 -0
- package/docs/SuggestAnalyticsWidgetsRequest.md +24 -0
- package/docs/Team.md +2 -2
- package/docs/TraitsApi.md +272 -0
- package/docs/UserRecordResponseDTO.md +1 -1
- package/docs/ViewDTO.md +12 -0
- package/index.ts +2 -0
- package/package.json +1 -1
package/docs/FilterItem.md
CHANGED
|
@@ -8,11 +8,13 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**object** | **string** | The name of the object to which this pagination item belongs. | [optional] [default to undefined]
|
|
10
10
|
**relation** | **string** | The relationship between objects. | [optional] [default to undefined]
|
|
11
|
+
**relationDirection** | **string** | Optional relation direction: outgoing (related→main), incoming (main→related), or omit for undirected. | [optional] [default to undefined]
|
|
11
12
|
**property** | **string** | The name of the property within the object. | [optional] [default to undefined]
|
|
12
13
|
**relationIncluded** | **boolean** | Specifies whether the relation is included. | [optional] [default to undefined]
|
|
13
14
|
**operator** | **string** | Defines the operator used in the filter. Available operators are defined in the API documentation. | [optional] [default to undefined]
|
|
14
15
|
**value** | **any** | | [optional] [default to undefined]
|
|
15
16
|
**smartContent** | **boolean** | When true, filter fields contain smart content placeholders resolved at runtime. | [optional] [default to undefined]
|
|
17
|
+
**edgeProperty** | **boolean** | When true, propertyName refers to a property stored on the relation edge itself (declared on the relation schema, e.g. partstat on attendees) instead of a property of the related record. Requires relation and propertyName. | [optional] [default to undefined]
|
|
16
18
|
|
|
17
19
|
## Example
|
|
18
20
|
|
|
@@ -22,11 +24,13 @@ import { FilterItem } from '@caraer/client';
|
|
|
22
24
|
const instance: FilterItem = {
|
|
23
25
|
object,
|
|
24
26
|
relation,
|
|
27
|
+
relationDirection,
|
|
25
28
|
property,
|
|
26
29
|
relationIncluded,
|
|
27
30
|
operator,
|
|
28
31
|
value,
|
|
29
32
|
smartContent,
|
|
33
|
+
edgeProperty,
|
|
30
34
|
};
|
|
31
35
|
```
|
|
32
36
|
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# GraphPathEvidence
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**path** | **Array<{ [key: string]: any | null; }>** | | [optional] [default to undefined]
|
|
9
|
+
**summary** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**relation** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**targetObject** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**recordUuid** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { GraphPathEvidence } from '@caraer/client';
|
|
18
|
+
|
|
19
|
+
const instance: GraphPathEvidence = {
|
|
20
|
+
path,
|
|
21
|
+
summary,
|
|
22
|
+
relation,
|
|
23
|
+
targetObject,
|
|
24
|
+
recordUuid,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# GraphTraversalSpec
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**relation** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**targetObject** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**direction** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**maxDepth** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**includeLifecycle** | **boolean** | | [optional] [default to undefined]
|
|
13
|
+
**includeActivities** | **boolean** | | [optional] [default to undefined]
|
|
14
|
+
**perRelationLimit** | **number** | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { GraphTraversalSpec } from '@caraer/client';
|
|
20
|
+
|
|
21
|
+
const instance: GraphTraversalSpec = {
|
|
22
|
+
relation,
|
|
23
|
+
targetObject,
|
|
24
|
+
direction,
|
|
25
|
+
maxDepth,
|
|
26
|
+
includeLifecycle,
|
|
27
|
+
includeActivities,
|
|
28
|
+
perRelationLimit,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Leadscore.md
CHANGED
|
@@ -8,11 +8,13 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**object** | **string** | The name of the object to which this pagination item belongs. | [optional] [default to undefined]
|
|
10
10
|
**relation** | **string** | The relationship between objects. | [optional] [default to undefined]
|
|
11
|
+
**relationDirection** | **string** | Optional relation direction: outgoing (related→main), incoming (main→related), or omit for undirected. | [optional] [default to undefined]
|
|
11
12
|
**property** | **string** | The name of the property within the object. | [optional] [default to undefined]
|
|
12
13
|
**relationIncluded** | **boolean** | Specifies whether the relation is included. | [optional] [default to undefined]
|
|
13
14
|
**operator** | **string** | Defines the operator used in the filter. Available operators are defined in the API documentation. | [optional] [default to undefined]
|
|
14
15
|
**value** | **any** | | [optional] [default to undefined]
|
|
15
16
|
**smartContent** | **boolean** | When true, filter fields contain smart content placeholders resolved at runtime. | [optional] [default to undefined]
|
|
17
|
+
**edgeProperty** | **boolean** | When true, propertyName refers to a property stored on the relation edge itself (declared on the relation schema, e.g. partstat on attendees) instead of a property of the related record. Requires relation and propertyName. | [optional] [default to undefined]
|
|
16
18
|
**smart_value** | **boolean** | Whether the value is a smart value | [optional] [default to undefined]
|
|
17
19
|
**score** | **number** | The score to assign if the rule is met | [optional] [default to undefined]
|
|
18
20
|
|
|
@@ -24,11 +26,13 @@ import { Leadscore } from '@caraer/client';
|
|
|
24
26
|
const instance: Leadscore = {
|
|
25
27
|
object,
|
|
26
28
|
relation,
|
|
29
|
+
relationDirection,
|
|
27
30
|
property,
|
|
28
31
|
relationIncluded,
|
|
29
32
|
operator,
|
|
30
33
|
value,
|
|
31
34
|
smartContent,
|
|
35
|
+
edgeProperty,
|
|
32
36
|
smart_value,
|
|
33
37
|
score,
|
|
34
38
|
};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# MigrateAppToV2Request
|
|
2
|
+
|
|
3
|
+
Request to migrate an existing V1 app to platform V2 (shared container runtime)
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**runtime** | **string** | Required when functions disagree or none set: nodejs22 or python312 | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { MigrateAppToV2Request } from '@caraer/client';
|
|
15
|
+
|
|
16
|
+
const instance: MigrateAppToV2Request = {
|
|
17
|
+
runtime,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/ObjectsApi.md
CHANGED
|
@@ -15,7 +15,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
15
15
|
|[**grantObjectAccess**](#grantobjectaccess) | **POST** /api/v2/objects/{objectUuid}/access-grant | Grant object record access|
|
|
16
16
|
|[**permanentlyDeleteArchivedObject**](#permanentlydeletearchivedobject) | **DELETE** /api/v2/objects/{uuid}/permanent | Permanently delete archived object|
|
|
17
17
|
|[**savePreview**](#savepreview) | **POST** /api/v2/objects/{uuid}/previews/{name} | Save object preview|
|
|
18
|
-
|[**
|
|
18
|
+
|[**syncExtendedObjects**](#syncextendedobjects) | **POST** /api/v2/objects/{uuid}/syncExtendedObjects | Sync extended objects for existing records|
|
|
19
19
|
|[**updateIndices3**](#updateindices3) | **PUT** /api/v2/objects/updateIndices | Update object indices|
|
|
20
20
|
|[**updateLifecycleProperties**](#updatelifecycleproperties) | **PUT** /api/v2/objects/{objectUuid}/lifecycle-properties | Configure lifecycle property tracking|
|
|
21
21
|
|[**updateObject**](#updateobject) | **PUT** /api/v2/objects/{uuid} | Update object by UUID|
|
|
@@ -638,10 +638,10 @@ const { status, data } = await apiInstance.savePreview(
|
|
|
638
638
|
|
|
639
639
|
[[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)
|
|
640
640
|
|
|
641
|
-
# **
|
|
642
|
-
> SuccessResponse
|
|
641
|
+
# **syncExtendedObjects**
|
|
642
|
+
> SuccessResponse syncExtendedObjects()
|
|
643
643
|
|
|
644
|
-
Synchronizes existing records for an object after
|
|
644
|
+
Synchronizes existing records for an object after extended configuration changes. The object path variable accepts UUID or object name. Records that reference the object as primary object, extended object, or label are re-extended.
|
|
645
645
|
|
|
646
646
|
### Example
|
|
647
647
|
|
|
@@ -656,7 +656,7 @@ const apiInstance = new ObjectsApi(configuration);
|
|
|
656
656
|
|
|
657
657
|
let uuid: string; // (default to undefined)
|
|
658
658
|
|
|
659
|
-
const { status, data } = await apiInstance.
|
|
659
|
+
const { status, data } = await apiInstance.syncExtendedObjects(
|
|
660
660
|
uuid
|
|
661
661
|
);
|
|
662
662
|
```
|
|
@@ -685,7 +685,7 @@ const { status, data } = await apiInstance.syncMorphObjects(
|
|
|
685
685
|
### HTTP response details
|
|
686
686
|
| Status code | Description | Response headers |
|
|
687
687
|
|-------------|-------------|------------------|
|
|
688
|
-
|**200** |
|
|
688
|
+
|**200** | Extended objects synchronized successfully | - |
|
|
689
689
|
|**404** | Object not found | - |
|
|
690
690
|
|**500** | Internal server error | - |
|
|
691
691
|
|
package/docs/PreviewDTO.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**object** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | The Caraer object associated with this preview | [optional] [default to undefined]
|
|
11
11
|
**recordUuid** | **string** | UUID of the associated record | [optional] [default to undefined]
|
|
12
12
|
**primary** | **boolean** | Indicates whether this preview is the primary one | [optional] [default to undefined]
|
|
13
|
+
**edgeProperties** | **{ [key: string]: any | null; }** | Values stored on the relation edge for properties declared on the relation schema. Only present when the preview was loaded through such a relation. | [optional] [default to undefined]
|
|
13
14
|
**grid** | **Array<Array<PreviewItemDTO>>** | Rows of the preview grid | [optional] [default to undefined]
|
|
14
15
|
**previewType** | **string** | Preview type | [optional] [default to undefined]
|
|
15
16
|
**profileImage** | [**PropertyDTO**](PropertyDTO.md) | Profile image property | [optional] [default to undefined]
|
|
@@ -46,6 +47,7 @@ const instance: PreviewDTO = {
|
|
|
46
47
|
object,
|
|
47
48
|
recordUuid,
|
|
48
49
|
primary,
|
|
50
|
+
edgeProperties,
|
|
49
51
|
grid,
|
|
50
52
|
previewType,
|
|
51
53
|
profileImage,
|
package/docs/Progress.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Progress
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**checkboxProperty** | [**PropertyDTO**](PropertyDTO.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { Progress } from '@caraer/client';
|
|
14
|
+
|
|
15
|
+
const instance: Progress = {
|
|
16
|
+
checkboxProperty,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/PropertyDTO.md
CHANGED
|
@@ -25,6 +25,7 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**immutable** | **boolean** | Indicates if the property value cannot be modified after initial creation | [optional] [default to undefined]
|
|
26
26
|
**hidden** | **boolean** | Indicates if the property should be hidden from view | [optional] [default to undefined]
|
|
27
27
|
**lifecycleActive** | **boolean** | When true, property value changes are tracked as lifecycle records | [optional] [default to undefined]
|
|
28
|
+
**requiredFilter** | [**Filter**](Filter.md) | When this filter matches the record being saved, the property becomes required | [optional] [default to undefined]
|
|
28
29
|
**nonPublic** | **boolean** | Indicates if the property should be excluded from public APIs | [optional] [default to undefined]
|
|
29
30
|
**indexed** | **boolean** | Indicates if the property should be indexed for searching | [optional] [default to undefined]
|
|
30
31
|
**editable** | **boolean** | Indicates if the property value can be modified | [optional] [default to undefined]
|
|
@@ -33,6 +34,7 @@ Name | Type | Description | Notes
|
|
|
33
34
|
**icon** | **string** | Icon identifier for visual representation of the property | [optional] [default to undefined]
|
|
34
35
|
**webpagePublic** | **boolean** | Indicates if the property can be used in webpages | [optional] [default to undefined]
|
|
35
36
|
**embeddable** | **boolean** | Indicates if the property can be embedded in other properties | [optional] [default to undefined]
|
|
37
|
+
**sensitive** | **boolean** | When true, exclude from advanced query evidence | [optional] [default to undefined]
|
|
36
38
|
**minAndMaxValue** | [**Tuple2LongLong**](Tuple2LongLong.md) | The minimum and maximum value of the property | [optional] [default to undefined]
|
|
37
39
|
**pinned** | **boolean** | Indicates if the property is pinned by the logged-in user | [optional] [default to undefined]
|
|
38
40
|
|
|
@@ -61,6 +63,7 @@ const instance: PropertyDTO = {
|
|
|
61
63
|
immutable,
|
|
62
64
|
hidden,
|
|
63
65
|
lifecycleActive,
|
|
66
|
+
requiredFilter,
|
|
64
67
|
nonPublic,
|
|
65
68
|
indexed,
|
|
66
69
|
editable,
|
|
@@ -69,6 +72,7 @@ const instance: PropertyDTO = {
|
|
|
69
72
|
icon,
|
|
70
73
|
webpagePublic,
|
|
71
74
|
embeddable,
|
|
75
|
+
sensitive,
|
|
72
76
|
minAndMaxValue,
|
|
73
77
|
pinned,
|
|
74
78
|
};
|
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**filters** | **Array<string>** | | [optional] [default to undefined]
|
|
15
15
|
**rules** | **Array<string>** | | [optional] [default to undefined]
|
|
16
16
|
**linkedProperty** | [**PropertyDTO**](PropertyDTO.md) | | [optional] [default to undefined]
|
|
17
|
+
**checkboxProperty** | [**PropertyDTO**](PropertyDTO.md) | | [optional] [default to undefined]
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -29,6 +30,7 @@ const instance: PropertyDTOFormat = {
|
|
|
29
30
|
filters,
|
|
30
31
|
rules,
|
|
31
32
|
linkedProperty,
|
|
33
|
+
checkboxProperty,
|
|
32
34
|
};
|
|
33
35
|
```
|
|
34
36
|
|
package/docs/PropertyOption.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**icon** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**color** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**disabled** | **boolean** | | [optional] [default to undefined]
|
|
13
|
+
**completed** | **boolean** | | [optional] [default to undefined]
|
|
13
14
|
**usedIn** | [**UsedInResult**](UsedInResult.md) | | [optional] [default to undefined]
|
|
14
15
|
|
|
15
16
|
## Example
|
|
@@ -23,6 +24,7 @@ const instance: PropertyOption = {
|
|
|
23
24
|
icon,
|
|
24
25
|
color,
|
|
25
26
|
disabled,
|
|
27
|
+
completed,
|
|
26
28
|
usedIn,
|
|
27
29
|
};
|
|
28
30
|
```
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# QueryEvidence
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**polarity** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**summary** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**sourceObject** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**sourceRecordUuid** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**relation** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**timestamp** | **number** | | [optional] [default to undefined]
|
|
15
|
+
**recencyWeight** | **number** | | [optional] [default to undefined]
|
|
16
|
+
**confidence** | **number** | | [optional] [default to undefined]
|
|
17
|
+
**properties** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
18
|
+
**paths** | [**Array<GraphPathEvidence>**](GraphPathEvidence.md) | | [optional] [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { QueryEvidence } from '@caraer/client';
|
|
24
|
+
|
|
25
|
+
const instance: QueryEvidence = {
|
|
26
|
+
type,
|
|
27
|
+
polarity,
|
|
28
|
+
summary,
|
|
29
|
+
sourceObject,
|
|
30
|
+
sourceRecordUuid,
|
|
31
|
+
relation,
|
|
32
|
+
timestamp,
|
|
33
|
+
recencyWeight,
|
|
34
|
+
confidence,
|
|
35
|
+
properties,
|
|
36
|
+
paths,
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Record.md
CHANGED
|
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**updatedByUuid** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**deletedByUuid** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**index** | **number** | | [optional] [default to undefined]
|
|
17
|
-
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
18
17
|
**complete** | **boolean** | | [optional] [default to undefined]
|
|
18
|
+
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**uuid** | **string** | | [default to undefined]
|
|
20
20
|
**properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
|
|
21
21
|
**objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
@@ -36,8 +36,8 @@ const instance: ModelRecord = {
|
|
|
36
36
|
updatedByUuid,
|
|
37
37
|
deletedByUuid,
|
|
38
38
|
index,
|
|
39
|
-
deleted,
|
|
40
39
|
complete,
|
|
40
|
+
deleted,
|
|
41
41
|
uuid,
|
|
42
42
|
properties,
|
|
43
43
|
objects,
|
package/docs/RecordDTO.md
CHANGED
|
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
|
|
17
17
|
**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
|
|
18
18
|
**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
|
|
19
|
-
**properties** | **{ [key: string]: any | null; }** |
|
|
19
|
+
**properties** | **{ [key: string]: any | null; }** | Property values as a name→value map, or a LEGACY array of {name,type,value} objects (same shape as LEGACY GET responses). | [optional] [default to undefined]
|
|
20
20
|
**user** | [**PublicUserDTO**](PublicUserDTO.md) | The user of the record if the user trait is enabled. | [optional] [default to undefined]
|
|
21
21
|
**relations** | [**Array<RecordRelationRequestDTO>**](RecordRelationRequestDTO.md) | Relations to create or merge after the record is saved. Each item links to an existing record (uuid) or creates a nested record first. | [optional] [default to undefined]
|
|
22
22
|
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**relationName** | **string** | Name of the relation type | [default to undefined]
|
|
10
10
|
**uuid** | **string** | UUID of an existing record to link to | [optional] [default to undefined]
|
|
11
11
|
**properties** | **{ [key: string]: any | null; }** | Properties to update on the existing record referenced by uuid before linking | [optional] [default to undefined]
|
|
12
|
+
**edgeProperties** | **{ [key: string]: any | null; }** | Values for properties declared on the relation schema, stored on the relation edge itself (not on either record). Omit to leave existing edge values untouched; a null value clears a key. | [optional] [default to undefined]
|
|
12
13
|
**record** | [**RecordDTO**](RecordDTO.md) | Nested record to create before linking, or update first when record.uuid is provided | [optional] [default to undefined]
|
|
13
14
|
**objectName** | **string** | Object name for nested record create when relation allows multiple target types | [optional] [default to undefined]
|
|
14
15
|
**primary** | **boolean** | When true, marks this relation edge as primary | [optional] [default to undefined]
|
|
@@ -23,6 +24,7 @@ const instance: RecordRelationRequestDTO = {
|
|
|
23
24
|
relationName,
|
|
24
25
|
uuid,
|
|
25
26
|
properties,
|
|
27
|
+
edgeProperties,
|
|
26
28
|
record,
|
|
27
29
|
objectName,
|
|
28
30
|
primary,
|