@caraer/client 2.0.595 → 2.0.597
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 +11 -3
- package/dist/api.d.ts +11 -3
- package/dist/esm/api.d.ts +11 -3
- package/docs/CaraerObjectDTO.md +4 -0
- package/docs/ExistingWidgetSummary.md +4 -4
- package/docs/FilledProperty.md +2 -2
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -1385,6 +1385,14 @@ export interface CaraerObjectDTO {
|
|
|
1385
1385
|
* When false, the object schema cannot be updated or deleted via the API
|
|
1386
1386
|
*/
|
|
1387
1387
|
'editable'?: boolean;
|
|
1388
|
+
/**
|
|
1389
|
+
* Permanently enable company-wide Number ID generation for this object and its descendants
|
|
1390
|
+
*/
|
|
1391
|
+
'numberIdEnabled'?: boolean;
|
|
1392
|
+
/**
|
|
1393
|
+
* Existing-record numbering status: PENDING, COMPLETE, or FAILED
|
|
1394
|
+
*/
|
|
1395
|
+
'numberIdBackfillStatus'?: string;
|
|
1388
1396
|
}
|
|
1389
1397
|
export interface CmsEnvironmentDTO {
|
|
1390
1398
|
'uuid'?: string;
|
|
@@ -2764,9 +2772,9 @@ export const EventRsvpRequestScopeEnum = {
|
|
|
2764
2772
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2765
2773
|
|
|
2766
2774
|
export interface ExistingWidgetSummary {
|
|
2767
|
-
'ymetric'?: string;
|
|
2768
|
-
'yproperty'?: string;
|
|
2769
2775
|
'xproperty'?: string;
|
|
2776
|
+
'yproperty'?: string;
|
|
2777
|
+
'ymetric'?: string;
|
|
2770
2778
|
'title'?: string;
|
|
2771
2779
|
'chartType'?: string;
|
|
2772
2780
|
'xProperty'?: string;
|
|
@@ -2848,10 +2856,10 @@ export interface FileListItemDTO {
|
|
|
2848
2856
|
'contentType'?: string;
|
|
2849
2857
|
}
|
|
2850
2858
|
export interface FilledProperty {
|
|
2851
|
-
'icon'?: string;
|
|
2852
2859
|
'name'?: string;
|
|
2853
2860
|
'value'?: any;
|
|
2854
2861
|
'type'?: string;
|
|
2862
|
+
'icon'?: string;
|
|
2855
2863
|
'label'?: string;
|
|
2856
2864
|
}
|
|
2857
2865
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -1374,6 +1374,14 @@ export interface CaraerObjectDTO {
|
|
|
1374
1374
|
* When false, the object schema cannot be updated or deleted via the API
|
|
1375
1375
|
*/
|
|
1376
1376
|
'editable'?: boolean;
|
|
1377
|
+
/**
|
|
1378
|
+
* Permanently enable company-wide Number ID generation for this object and its descendants
|
|
1379
|
+
*/
|
|
1380
|
+
'numberIdEnabled'?: boolean;
|
|
1381
|
+
/**
|
|
1382
|
+
* Existing-record numbering status: PENDING, COMPLETE, or FAILED
|
|
1383
|
+
*/
|
|
1384
|
+
'numberIdBackfillStatus'?: string;
|
|
1377
1385
|
}
|
|
1378
1386
|
export interface CmsEnvironmentDTO {
|
|
1379
1387
|
'uuid'?: string;
|
|
@@ -2757,9 +2765,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2757
2765
|
};
|
|
2758
2766
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2759
2767
|
export interface ExistingWidgetSummary {
|
|
2760
|
-
'ymetric'?: string;
|
|
2761
|
-
'yproperty'?: string;
|
|
2762
2768
|
'xproperty'?: string;
|
|
2769
|
+
'yproperty'?: string;
|
|
2770
|
+
'ymetric'?: string;
|
|
2763
2771
|
'title'?: string;
|
|
2764
2772
|
'chartType'?: string;
|
|
2765
2773
|
'xProperty'?: string;
|
|
@@ -2841,10 +2849,10 @@ export interface FileListItemDTO {
|
|
|
2841
2849
|
'contentType'?: string;
|
|
2842
2850
|
}
|
|
2843
2851
|
export interface FilledProperty {
|
|
2844
|
-
'icon'?: string;
|
|
2845
2852
|
'name'?: string;
|
|
2846
2853
|
'value'?: any;
|
|
2847
2854
|
'type'?: string;
|
|
2855
|
+
'icon'?: string;
|
|
2848
2856
|
'label'?: string;
|
|
2849
2857
|
}
|
|
2850
2858
|
/**
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1374,6 +1374,14 @@ export interface CaraerObjectDTO {
|
|
|
1374
1374
|
* When false, the object schema cannot be updated or deleted via the API
|
|
1375
1375
|
*/
|
|
1376
1376
|
'editable'?: boolean;
|
|
1377
|
+
/**
|
|
1378
|
+
* Permanently enable company-wide Number ID generation for this object and its descendants
|
|
1379
|
+
*/
|
|
1380
|
+
'numberIdEnabled'?: boolean;
|
|
1381
|
+
/**
|
|
1382
|
+
* Existing-record numbering status: PENDING, COMPLETE, or FAILED
|
|
1383
|
+
*/
|
|
1384
|
+
'numberIdBackfillStatus'?: string;
|
|
1377
1385
|
}
|
|
1378
1386
|
export interface CmsEnvironmentDTO {
|
|
1379
1387
|
'uuid'?: string;
|
|
@@ -2757,9 +2765,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2757
2765
|
};
|
|
2758
2766
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2759
2767
|
export interface ExistingWidgetSummary {
|
|
2760
|
-
'ymetric'?: string;
|
|
2761
|
-
'yproperty'?: string;
|
|
2762
2768
|
'xproperty'?: string;
|
|
2769
|
+
'yproperty'?: string;
|
|
2770
|
+
'ymetric'?: string;
|
|
2763
2771
|
'title'?: string;
|
|
2764
2772
|
'chartType'?: string;
|
|
2765
2773
|
'xProperty'?: string;
|
|
@@ -2841,10 +2849,10 @@ export interface FileListItemDTO {
|
|
|
2841
2849
|
'contentType'?: string;
|
|
2842
2850
|
}
|
|
2843
2851
|
export interface FilledProperty {
|
|
2844
|
-
'icon'?: string;
|
|
2845
2852
|
'name'?: string;
|
|
2846
2853
|
'value'?: any;
|
|
2847
2854
|
'type'?: string;
|
|
2855
|
+
'icon'?: string;
|
|
2848
2856
|
'label'?: string;
|
|
2849
2857
|
}
|
|
2850
2858
|
/**
|
package/docs/CaraerObjectDTO.md
CHANGED
|
@@ -28,6 +28,8 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**suites** | **Array<string>** | List of suite names this object belongs to | [optional] [default to undefined]
|
|
29
29
|
**extendsTo** | [**Array<CaraerObjectDTO>**](CaraerObjectDTO.md) | List of objects this object extends to | [optional] [default to undefined]
|
|
30
30
|
**editable** | **boolean** | When false, the object schema cannot be updated or deleted via the API | [optional] [default to undefined]
|
|
31
|
+
**numberIdEnabled** | **boolean** | Permanently enable company-wide Number ID generation for this object and its descendants | [optional] [default to undefined]
|
|
32
|
+
**numberIdBackfillStatus** | **string** | Existing-record numbering status: PENDING, COMPLETE, or FAILED | [optional] [readonly] [default to undefined]
|
|
31
33
|
|
|
32
34
|
## Example
|
|
33
35
|
|
|
@@ -57,6 +59,8 @@ const instance: CaraerObjectDTO = {
|
|
|
57
59
|
suites,
|
|
58
60
|
extendsTo,
|
|
59
61
|
editable,
|
|
62
|
+
numberIdEnabled,
|
|
63
|
+
numberIdBackfillStatus,
|
|
60
64
|
};
|
|
61
65
|
```
|
|
62
66
|
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**ymetric** | **string** | | [optional] [default to undefined]
|
|
9
|
-
**yproperty** | **string** | | [optional] [default to undefined]
|
|
10
8
|
**xproperty** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**yproperty** | **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]
|
|
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
|
|
|
20
20
|
import { ExistingWidgetSummary } from '@caraer/client';
|
|
21
21
|
|
|
22
22
|
const instance: ExistingWidgetSummary = {
|
|
23
|
-
ymetric,
|
|
24
|
-
yproperty,
|
|
25
23
|
xproperty,
|
|
24
|
+
yproperty,
|
|
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
|
```
|