@caraer/client 2.0.575 → 2.0.582
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 +1 -0
- package/.openapi-generator-ignore +2 -0
- package/README.md +33 -1
- package/api.ts +284 -34
- package/dist/api.d.ts +153 -25
- package/dist/api.js +264 -33
- package/dist/esm/api.d.ts +153 -25
- package/dist/esm/api.js +257 -30
- package/docs/AppSettingFieldSchema.md +2 -0
- package/docs/ApplicationsApi.md +1 -1
- package/docs/CMSV2PublicApi.md +4 -1
- package/docs/CMSWebsiteUpdatesApi.md +159 -0
- package/docs/CompanyDTO.md +2 -0
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/FilledProperty.md +2 -2
- package/docs/PropertyApi.md +1 -1
- package/docs/RecordDTO.md +1 -1
- package/docs/RecordsApi.md +4 -4
- package/docs/WebpageDTO.md +4 -0
- package/docs/WebsiteSettingsDTO.md +2 -0
- package/package.json +1 -1
package/docs/CompanyDTO.md
CHANGED
|
@@ -16,6 +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
|
+
**subdomain** | **string** | The company\'s canonical subdomain, independent of website settings. | [optional] [readonly] [default to undefined]
|
|
19
20
|
**details** | [**CompanyDetailsDTO**](CompanyDetailsDTO.md) | The details of the company. | [optional] [default to undefined]
|
|
20
21
|
**digitalIdentity** | [**DigitalIdentityDTO**](DigitalIdentityDTO.md) | The digital identity of the company. | [optional] [default to undefined]
|
|
21
22
|
**websiteSettings** | [**WebsiteSettingsDTO**](WebsiteSettingsDTO.md) | The website settings of the company. | [optional] [default to undefined]
|
|
@@ -41,6 +42,7 @@ const instance: CompanyDTO = {
|
|
|
41
42
|
deletedAt,
|
|
42
43
|
deletedBy,
|
|
43
44
|
index,
|
|
45
|
+
subdomain,
|
|
44
46
|
details,
|
|
45
47
|
digitalIdentity,
|
|
46
48
|
websiteSettings,
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**yproperty** | **string** | | [optional] [default to undefined]
|
|
9
|
-
**ymetric** | **string** | | [optional] [default to undefined]
|
|
10
9
|
**xproperty** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**ymetric** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**chartType** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**xProperty** | **string** | | [optional] [default to undefined]
|
|
@@ -21,8 +21,8 @@ import { ExistingWidgetSummary } from '@caraer/client';
|
|
|
21
21
|
|
|
22
22
|
const instance: ExistingWidgetSummary = {
|
|
23
23
|
yproperty,
|
|
24
|
-
ymetric,
|
|
25
24
|
xproperty,
|
|
25
|
+
ymetric,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
28
28
|
xProperty,
|
package/docs/FilledProperty.md
CHANGED
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**icon** | **string** | | [optional] [default to undefined]
|
|
9
8
|
**name** | **string** | | [optional] [default to undefined]
|
|
10
9
|
**value** | **any** | | [optional] [default to undefined]
|
|
11
10
|
**type** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**icon** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**label** | **string** | | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
@@ -17,10 +17,10 @@ Name | Type | Description | Notes
|
|
|
17
17
|
import { FilledProperty } from '@caraer/client';
|
|
18
18
|
|
|
19
19
|
const instance: FilledProperty = {
|
|
20
|
-
icon,
|
|
21
20
|
name,
|
|
22
21
|
value,
|
|
23
22
|
type,
|
|
23
|
+
icon,
|
|
24
24
|
label,
|
|
25
25
|
};
|
|
26
26
|
```
|
package/docs/PropertyApi.md
CHANGED
|
@@ -486,7 +486,7 @@ const { status, data } = await apiInstance.getPropertyCalculationTypes(
|
|
|
486
486
|
# **permanentlyDeleteArchivedProperty**
|
|
487
487
|
> DeleteResponse permanentlyDeleteArchivedProperty()
|
|
488
488
|
|
|
489
|
-
Deletes the soft-deleted HAS_PROPERTY link to this object.
|
|
489
|
+
Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
|
|
490
490
|
|
|
491
491
|
### Example
|
|
492
492
|
|
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; }** | 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]
|
|
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). File properties accept existing company file keys/URLs, an inline upload object {fileName,contentBase64,contentType?}, or a base64 data URL. Bare base64 bytes require the object form with fileName. Multi-file properties also accept an ordered array mixing existing keys/URLs and inline uploads; semicolon-separated keys and null remain supported. Uploads are stored as ordinary file keys after authorization and property validation. File type and configured upload size limits apply; base64 text counts toward the request limit. | [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
|
|
package/docs/RecordsApi.md
CHANGED
|
@@ -18,7 +18,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
18
18
|
|[**indexFlow**](#indexflow) | **POST** /api/v2/records/index/flow | Fetch records for flow view|
|
|
19
19
|
|[**indexPage**](#indexpage) | **POST** /api/v2/records/index/page | Fetch records for page view|
|
|
20
20
|
|[**indexTable**](#indextable) | **POST** /api/v2/records/index/table | Fetch records for table view|
|
|
21
|
-
|[**
|
|
21
|
+
|[**preview1**](#preview1) | **GET** /api/v2/records/{uuid}/previews/{name} | Get record preview|
|
|
22
22
|
|[**query**](#query) | **POST** /api/v2/records/query | Advanced graph-aware record query|
|
|
23
23
|
|[**restore**](#restore) | **POST** /api/v2/records/{uuid}/restore | Restore a deleted record|
|
|
24
24
|
|[**search**](#search) | **POST** /api/v2/records/search | Search records|
|
|
@@ -923,8 +923,8 @@ const { status, data } = await apiInstance.indexTable(
|
|
|
923
923
|
|
|
924
924
|
[[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)
|
|
925
925
|
|
|
926
|
-
# **
|
|
927
|
-
> ShowResponsePreviewDTO
|
|
926
|
+
# **preview1**
|
|
927
|
+
> ShowResponsePreviewDTO preview1()
|
|
928
928
|
|
|
929
929
|
Retrieves a preview for a record specified by its UUID and preview name. Returns a ShowResponse containing the preview data.
|
|
930
930
|
|
|
@@ -944,7 +944,7 @@ let name: string; // (default to undefined)
|
|
|
944
944
|
let object: string; //Optional object name used to resolve the record before building the preview. (optional) (default to undefined)
|
|
945
945
|
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)
|
|
946
946
|
|
|
947
|
-
const { status, data } = await apiInstance.
|
|
947
|
+
const { status, data } = await apiInstance.preview1(
|
|
948
948
|
uuid,
|
|
949
949
|
name,
|
|
950
950
|
object,
|
package/docs/WebpageDTO.md
CHANGED
|
@@ -6,6 +6,8 @@ Data transfer object representing a webpage with its various states, properties,
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**canonicalUrl** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**lastModified** | **string** | | [optional] [default to undefined]
|
|
9
11
|
**environment** | **string** | The environment of the webpage. | [optional] [default to undefined]
|
|
10
12
|
**uuid** | **string** | The UUID of the webpage. | [optional] [default to undefined]
|
|
11
13
|
**title** | **string** | The title of the webpage. | [optional] [default to undefined]
|
|
@@ -40,6 +42,8 @@ Name | Type | Description | Notes
|
|
|
40
42
|
import { WebpageDTO } from '@caraer/client';
|
|
41
43
|
|
|
42
44
|
const instance: WebpageDTO = {
|
|
45
|
+
canonicalUrl,
|
|
46
|
+
lastModified,
|
|
43
47
|
environment,
|
|
44
48
|
uuid,
|
|
45
49
|
title,
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**subdomain** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**customDomain** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**primaryEnvironment** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**recordType** | **string** | | [optional] [default to undefined]
|
|
12
13
|
**recordValue** | **string** | | [optional] [default to undefined]
|
|
13
14
|
**favicon** | **string** | | [optional] [default to undefined]
|
|
@@ -173,6 +174,7 @@ import { WebsiteSettingsDTO } from '@caraer/client';
|
|
|
173
174
|
const instance: WebsiteSettingsDTO = {
|
|
174
175
|
subdomain,
|
|
175
176
|
customDomain,
|
|
177
|
+
primaryEnvironment,
|
|
176
178
|
recordType,
|
|
177
179
|
recordValue,
|
|
178
180
|
favicon,
|