@caraer/client 2.0.527 → 2.0.529
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 +4 -0
- package/api.ts +39 -1
- package/dist/api.d.ts +39 -1
- package/dist/esm/api.d.ts +39 -1
- package/docs/AppSettingFieldMappingStructureItem.md +4 -0
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/FeedFormatPreviewDTO.md +34 -0
- package/docs/FeedFormatPreviewRequest.md +28 -0
- package/docs/FeedFormatSuggestionRequest.md +26 -0
- package/docs/SuccessResponseFeedFormatPreviewDTO.md +23 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -129,6 +129,9 @@ docs/EventRsvpRequest.md
|
|
|
129
129
|
docs/ExistingWidgetSummary.md
|
|
130
130
|
docs/ExtendRecordRequest.md
|
|
131
131
|
docs/FeedDTO.md
|
|
132
|
+
docs/FeedFormatPreviewDTO.md
|
|
133
|
+
docs/FeedFormatPreviewRequest.md
|
|
134
|
+
docs/FeedFormatSuggestionRequest.md
|
|
132
135
|
docs/FeedImportRunDTO.md
|
|
133
136
|
docs/FeedsApi.md
|
|
134
137
|
docs/File.md
|
|
@@ -328,6 +331,7 @@ docs/SuccessResponseCalendarBootstrapDTO.md
|
|
|
328
331
|
docs/SuccessResponseCollectionRelation.md
|
|
329
332
|
docs/SuccessResponseCompanyDTO.md
|
|
330
333
|
docs/SuccessResponseFeedDTO.md
|
|
334
|
+
docs/SuccessResponseFeedFormatPreviewDTO.md
|
|
331
335
|
docs/SuccessResponseFeedImportRunDTO.md
|
|
332
336
|
docs/SuccessResponseFlow.md
|
|
333
337
|
docs/SuccessResponseListAggregateResponse.md
|
package/api.ts
CHANGED
|
@@ -967,6 +967,8 @@ export interface AppSettingFieldMappingStructureItem {
|
|
|
967
967
|
'relationName'?: string;
|
|
968
968
|
'objectName'?: string;
|
|
969
969
|
'recordUuid'?: string;
|
|
970
|
+
'formatPattern'?: string;
|
|
971
|
+
'formatReplacement'?: string;
|
|
970
972
|
}
|
|
971
973
|
export interface AppSettingFieldSchema {
|
|
972
974
|
'name'?: string;
|
|
@@ -2581,9 +2583,9 @@ export const EventRsvpRequestScopeEnum = {
|
|
|
2581
2583
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2582
2584
|
|
|
2583
2585
|
export interface ExistingWidgetSummary {
|
|
2586
|
+
'xproperty'?: string;
|
|
2584
2587
|
'yproperty'?: string;
|
|
2585
2588
|
'ymetric'?: string;
|
|
2586
|
-
'xproperty'?: string;
|
|
2587
2589
|
'title'?: string;
|
|
2588
2590
|
'chartType'?: string;
|
|
2589
2591
|
'xProperty'?: string;
|
|
@@ -2678,6 +2680,29 @@ export interface FeedDTO {
|
|
|
2678
2680
|
'availableEnvironments'?: Array<string>;
|
|
2679
2681
|
'siblingImportFeeds'?: Array<string>;
|
|
2680
2682
|
}
|
|
2683
|
+
export interface FeedFormatPreviewDTO {
|
|
2684
|
+
'sample'?: string;
|
|
2685
|
+
'formatPattern'?: string;
|
|
2686
|
+
'formatReplacement'?: string;
|
|
2687
|
+
'output'?: string;
|
|
2688
|
+
'matches'?: boolean;
|
|
2689
|
+
'storedValuePattern'?: string;
|
|
2690
|
+
'storedValueHint'?: string;
|
|
2691
|
+
'formatName'?: string;
|
|
2692
|
+
}
|
|
2693
|
+
export interface FeedFormatPreviewRequest {
|
|
2694
|
+
'sample'?: string;
|
|
2695
|
+
'formatPattern'?: string;
|
|
2696
|
+
'formatReplacement'?: string;
|
|
2697
|
+
'propertyName'?: string;
|
|
2698
|
+
'objectName'?: string;
|
|
2699
|
+
}
|
|
2700
|
+
export interface FeedFormatSuggestionRequest {
|
|
2701
|
+
'feed'?: FeedDTO;
|
|
2702
|
+
'fieldName'?: string;
|
|
2703
|
+
'propertyName'?: string;
|
|
2704
|
+
'objectName'?: string;
|
|
2705
|
+
}
|
|
2681
2706
|
export interface FeedImportRunDTO {
|
|
2682
2707
|
'dryRun'?: boolean;
|
|
2683
2708
|
'status'?: string;
|
|
@@ -6955,6 +6980,19 @@ export interface SuccessResponseFeedDTO {
|
|
|
6955
6980
|
*/
|
|
6956
6981
|
'data'?: FeedDTO;
|
|
6957
6982
|
}
|
|
6983
|
+
/**
|
|
6984
|
+
* Represents a standard successful response with a message and optional data.
|
|
6985
|
+
*/
|
|
6986
|
+
export interface SuccessResponseFeedFormatPreviewDTO {
|
|
6987
|
+
/**
|
|
6988
|
+
* A message detailing the result of the operation.
|
|
6989
|
+
*/
|
|
6990
|
+
'message'?: string;
|
|
6991
|
+
/**
|
|
6992
|
+
* The data payload of the response, if any.
|
|
6993
|
+
*/
|
|
6994
|
+
'data'?: FeedFormatPreviewDTO;
|
|
6995
|
+
}
|
|
6958
6996
|
/**
|
|
6959
6997
|
* Represents a standard successful response with a message and optional data.
|
|
6960
6998
|
*/
|
package/dist/api.d.ts
CHANGED
|
@@ -957,6 +957,8 @@ export interface AppSettingFieldMappingStructureItem {
|
|
|
957
957
|
'relationName'?: string;
|
|
958
958
|
'objectName'?: string;
|
|
959
959
|
'recordUuid'?: string;
|
|
960
|
+
'formatPattern'?: string;
|
|
961
|
+
'formatReplacement'?: string;
|
|
960
962
|
}
|
|
961
963
|
export interface AppSettingFieldSchema {
|
|
962
964
|
'name'?: string;
|
|
@@ -2571,9 +2573,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2571
2573
|
};
|
|
2572
2574
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2573
2575
|
export interface ExistingWidgetSummary {
|
|
2576
|
+
'xproperty'?: string;
|
|
2574
2577
|
'yproperty'?: string;
|
|
2575
2578
|
'ymetric'?: string;
|
|
2576
|
-
'xproperty'?: string;
|
|
2577
2579
|
'title'?: string;
|
|
2578
2580
|
'chartType'?: string;
|
|
2579
2581
|
'xProperty'?: string;
|
|
@@ -2668,6 +2670,29 @@ export interface FeedDTO {
|
|
|
2668
2670
|
'availableEnvironments'?: Array<string>;
|
|
2669
2671
|
'siblingImportFeeds'?: Array<string>;
|
|
2670
2672
|
}
|
|
2673
|
+
export interface FeedFormatPreviewDTO {
|
|
2674
|
+
'sample'?: string;
|
|
2675
|
+
'formatPattern'?: string;
|
|
2676
|
+
'formatReplacement'?: string;
|
|
2677
|
+
'output'?: string;
|
|
2678
|
+
'matches'?: boolean;
|
|
2679
|
+
'storedValuePattern'?: string;
|
|
2680
|
+
'storedValueHint'?: string;
|
|
2681
|
+
'formatName'?: string;
|
|
2682
|
+
}
|
|
2683
|
+
export interface FeedFormatPreviewRequest {
|
|
2684
|
+
'sample'?: string;
|
|
2685
|
+
'formatPattern'?: string;
|
|
2686
|
+
'formatReplacement'?: string;
|
|
2687
|
+
'propertyName'?: string;
|
|
2688
|
+
'objectName'?: string;
|
|
2689
|
+
}
|
|
2690
|
+
export interface FeedFormatSuggestionRequest {
|
|
2691
|
+
'feed'?: FeedDTO;
|
|
2692
|
+
'fieldName'?: string;
|
|
2693
|
+
'propertyName'?: string;
|
|
2694
|
+
'objectName'?: string;
|
|
2695
|
+
}
|
|
2671
2696
|
export interface FeedImportRunDTO {
|
|
2672
2697
|
'dryRun'?: boolean;
|
|
2673
2698
|
'status'?: string;
|
|
@@ -7057,6 +7082,19 @@ export interface SuccessResponseFeedDTO {
|
|
|
7057
7082
|
*/
|
|
7058
7083
|
'data'?: FeedDTO;
|
|
7059
7084
|
}
|
|
7085
|
+
/**
|
|
7086
|
+
* Represents a standard successful response with a message and optional data.
|
|
7087
|
+
*/
|
|
7088
|
+
export interface SuccessResponseFeedFormatPreviewDTO {
|
|
7089
|
+
/**
|
|
7090
|
+
* A message detailing the result of the operation.
|
|
7091
|
+
*/
|
|
7092
|
+
'message'?: string;
|
|
7093
|
+
/**
|
|
7094
|
+
* The data payload of the response, if any.
|
|
7095
|
+
*/
|
|
7096
|
+
'data'?: FeedFormatPreviewDTO;
|
|
7097
|
+
}
|
|
7060
7098
|
/**
|
|
7061
7099
|
* Represents a standard successful response with a message and optional data.
|
|
7062
7100
|
*/
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -957,6 +957,8 @@ export interface AppSettingFieldMappingStructureItem {
|
|
|
957
957
|
'relationName'?: string;
|
|
958
958
|
'objectName'?: string;
|
|
959
959
|
'recordUuid'?: string;
|
|
960
|
+
'formatPattern'?: string;
|
|
961
|
+
'formatReplacement'?: string;
|
|
960
962
|
}
|
|
961
963
|
export interface AppSettingFieldSchema {
|
|
962
964
|
'name'?: string;
|
|
@@ -2571,9 +2573,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2571
2573
|
};
|
|
2572
2574
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2573
2575
|
export interface ExistingWidgetSummary {
|
|
2576
|
+
'xproperty'?: string;
|
|
2574
2577
|
'yproperty'?: string;
|
|
2575
2578
|
'ymetric'?: string;
|
|
2576
|
-
'xproperty'?: string;
|
|
2577
2579
|
'title'?: string;
|
|
2578
2580
|
'chartType'?: string;
|
|
2579
2581
|
'xProperty'?: string;
|
|
@@ -2668,6 +2670,29 @@ export interface FeedDTO {
|
|
|
2668
2670
|
'availableEnvironments'?: Array<string>;
|
|
2669
2671
|
'siblingImportFeeds'?: Array<string>;
|
|
2670
2672
|
}
|
|
2673
|
+
export interface FeedFormatPreviewDTO {
|
|
2674
|
+
'sample'?: string;
|
|
2675
|
+
'formatPattern'?: string;
|
|
2676
|
+
'formatReplacement'?: string;
|
|
2677
|
+
'output'?: string;
|
|
2678
|
+
'matches'?: boolean;
|
|
2679
|
+
'storedValuePattern'?: string;
|
|
2680
|
+
'storedValueHint'?: string;
|
|
2681
|
+
'formatName'?: string;
|
|
2682
|
+
}
|
|
2683
|
+
export interface FeedFormatPreviewRequest {
|
|
2684
|
+
'sample'?: string;
|
|
2685
|
+
'formatPattern'?: string;
|
|
2686
|
+
'formatReplacement'?: string;
|
|
2687
|
+
'propertyName'?: string;
|
|
2688
|
+
'objectName'?: string;
|
|
2689
|
+
}
|
|
2690
|
+
export interface FeedFormatSuggestionRequest {
|
|
2691
|
+
'feed'?: FeedDTO;
|
|
2692
|
+
'fieldName'?: string;
|
|
2693
|
+
'propertyName'?: string;
|
|
2694
|
+
'objectName'?: string;
|
|
2695
|
+
}
|
|
2671
2696
|
export interface FeedImportRunDTO {
|
|
2672
2697
|
'dryRun'?: boolean;
|
|
2673
2698
|
'status'?: string;
|
|
@@ -7057,6 +7082,19 @@ export interface SuccessResponseFeedDTO {
|
|
|
7057
7082
|
*/
|
|
7058
7083
|
'data'?: FeedDTO;
|
|
7059
7084
|
}
|
|
7085
|
+
/**
|
|
7086
|
+
* Represents a standard successful response with a message and optional data.
|
|
7087
|
+
*/
|
|
7088
|
+
export interface SuccessResponseFeedFormatPreviewDTO {
|
|
7089
|
+
/**
|
|
7090
|
+
* A message detailing the result of the operation.
|
|
7091
|
+
*/
|
|
7092
|
+
'message'?: string;
|
|
7093
|
+
/**
|
|
7094
|
+
* The data payload of the response, if any.
|
|
7095
|
+
*/
|
|
7096
|
+
'data'?: FeedFormatPreviewDTO;
|
|
7097
|
+
}
|
|
7060
7098
|
/**
|
|
7061
7099
|
* Represents a standard successful response with a message and optional data.
|
|
7062
7100
|
*/
|
|
@@ -16,6 +16,8 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**relationName** | **string** | | [optional] [default to undefined]
|
|
17
17
|
**objectName** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**recordUuid** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**formatPattern** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**formatReplacement** | **string** | | [optional] [default to undefined]
|
|
19
21
|
|
|
20
22
|
## Example
|
|
21
23
|
|
|
@@ -34,6 +36,8 @@ const instance: AppSettingFieldMappingStructureItem = {
|
|
|
34
36
|
relationName,
|
|
35
37
|
objectName,
|
|
36
38
|
recordUuid,
|
|
39
|
+
formatPattern,
|
|
40
|
+
formatReplacement,
|
|
37
41
|
};
|
|
38
42
|
```
|
|
39
43
|
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**xproperty** | **string** | | [optional] [default to undefined]
|
|
8
9
|
**yproperty** | **string** | | [optional] [default to undefined]
|
|
9
10
|
**ymetric** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**xproperty** | **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
|
+
xproperty,
|
|
23
24
|
yproperty,
|
|
24
25
|
ymetric,
|
|
25
|
-
xproperty,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
28
28
|
xProperty,
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# FeedFormatPreviewDTO
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**sample** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**formatPattern** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**formatReplacement** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**output** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**matches** | **boolean** | | [optional] [default to undefined]
|
|
13
|
+
**storedValuePattern** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**storedValueHint** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**formatName** | **string** | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { FeedFormatPreviewDTO } from '@caraer/client';
|
|
21
|
+
|
|
22
|
+
const instance: FeedFormatPreviewDTO = {
|
|
23
|
+
sample,
|
|
24
|
+
formatPattern,
|
|
25
|
+
formatReplacement,
|
|
26
|
+
output,
|
|
27
|
+
matches,
|
|
28
|
+
storedValuePattern,
|
|
29
|
+
storedValueHint,
|
|
30
|
+
formatName,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[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,28 @@
|
|
|
1
|
+
# FeedFormatPreviewRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**sample** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**formatPattern** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**formatReplacement** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**propertyName** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**objectName** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { FeedFormatPreviewRequest } from '@caraer/client';
|
|
18
|
+
|
|
19
|
+
const instance: FeedFormatPreviewRequest = {
|
|
20
|
+
sample,
|
|
21
|
+
formatPattern,
|
|
22
|
+
formatReplacement,
|
|
23
|
+
propertyName,
|
|
24
|
+
objectName,
|
|
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,26 @@
|
|
|
1
|
+
# FeedFormatSuggestionRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**feed** | [**FeedDTO**](FeedDTO.md) | | [optional] [default to undefined]
|
|
9
|
+
**fieldName** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**propertyName** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**objectName** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { FeedFormatSuggestionRequest } from '@caraer/client';
|
|
17
|
+
|
|
18
|
+
const instance: FeedFormatSuggestionRequest = {
|
|
19
|
+
feed,
|
|
20
|
+
fieldName,
|
|
21
|
+
propertyName,
|
|
22
|
+
objectName,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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,23 @@
|
|
|
1
|
+
# SuccessResponseFeedFormatPreviewDTO
|
|
2
|
+
|
|
3
|
+
Represents a standard successful response with a message and optional data.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
|
|
10
|
+
**data** | [**FeedFormatPreviewDTO**](FeedFormatPreviewDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { SuccessResponseFeedFormatPreviewDTO } from '@caraer/client';
|
|
16
|
+
|
|
17
|
+
const instance: SuccessResponseFeedFormatPreviewDTO = {
|
|
18
|
+
message,
|
|
19
|
+
data,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|