@caraer/client 2.0.415 → 2.0.416
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 +5 -2
- package/dist/api.d.ts +5 -2
- package/dist/api.js +2 -0
- package/dist/esm/api.d.ts +5 -2
- package/dist/esm/api.js +2 -0
- package/docs/AppBarDTO.md +1 -1
- package/docs/AppBarVisibilityEntry.md +2 -0
- package/docs/AppBarsApi.md +2 -2
- package/docs/ExistingWidgetSummary.md +2 -2
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -282,7 +282,7 @@ export interface AppBarDTO {
|
|
|
282
282
|
*/
|
|
283
283
|
'index'?: number;
|
|
284
284
|
/**
|
|
285
|
-
* Bar location: RECORD_PREVIEW, RECORD_OVERVIEW, RECORD_DETAIL, TOOL_BAR, TRAIT_BAR
|
|
285
|
+
* Bar location: RECORD_PREVIEW, RECORD_OVERVIEW, RECORD_DETAIL, TOOL_BAR, TRAIT_BAR, RECORD_TRAIT
|
|
286
286
|
*/
|
|
287
287
|
'location'?: AppBarDTOLocationEnum;
|
|
288
288
|
/**
|
|
@@ -321,6 +321,7 @@ export const AppBarDTOLocationEnum = {
|
|
|
321
321
|
RecordDetail: 'RECORD_DETAIL',
|
|
322
322
|
ToolBar: 'TOOL_BAR',
|
|
323
323
|
TraitBar: 'TRAIT_BAR',
|
|
324
|
+
RecordTrait: 'RECORD_TRAIT',
|
|
324
325
|
} as const;
|
|
325
326
|
|
|
326
327
|
export type AppBarDTOLocationEnum = typeof AppBarDTOLocationEnum[keyof typeof AppBarDTOLocationEnum];
|
|
@@ -391,6 +392,7 @@ export interface AppBarTriggerRequest {
|
|
|
391
392
|
export interface AppBarVisibilityEntry {
|
|
392
393
|
'objects'?: Array<string>;
|
|
393
394
|
'suites'?: Array<string>;
|
|
395
|
+
'traits'?: Array<string>;
|
|
394
396
|
}
|
|
395
397
|
export interface AppConnectionStatusDTO {
|
|
396
398
|
'id'?: string;
|
|
@@ -2087,8 +2089,8 @@ export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof t
|
|
|
2087
2089
|
|
|
2088
2090
|
export interface ExistingWidgetSummary {
|
|
2089
2091
|
'ymetric'?: string;
|
|
2090
|
-
'yproperty'?: string;
|
|
2091
2092
|
'xproperty'?: string;
|
|
2093
|
+
'yproperty'?: string;
|
|
2092
2094
|
'title'?: string;
|
|
2093
2095
|
'chartType'?: string;
|
|
2094
2096
|
'xProperty'?: string;
|
|
@@ -6551,6 +6553,7 @@ export const ListAppBarsLocationEnum = {
|
|
|
6551
6553
|
RecordDetail: 'RECORD_DETAIL',
|
|
6552
6554
|
ToolBar: 'TOOL_BAR',
|
|
6553
6555
|
TraitBar: 'TRAIT_BAR',
|
|
6556
|
+
RecordTrait: 'RECORD_TRAIT',
|
|
6554
6557
|
} as const;
|
|
6555
6558
|
export type ListAppBarsLocationEnum = typeof ListAppBarsLocationEnum[keyof typeof ListAppBarsLocationEnum];
|
|
6556
6559
|
|
package/dist/api.d.ts
CHANGED
|
@@ -272,7 +272,7 @@ export interface AppBarDTO {
|
|
|
272
272
|
*/
|
|
273
273
|
'index'?: number;
|
|
274
274
|
/**
|
|
275
|
-
* Bar location: RECORD_PREVIEW, RECORD_OVERVIEW, RECORD_DETAIL, TOOL_BAR, TRAIT_BAR
|
|
275
|
+
* Bar location: RECORD_PREVIEW, RECORD_OVERVIEW, RECORD_DETAIL, TOOL_BAR, TRAIT_BAR, RECORD_TRAIT
|
|
276
276
|
*/
|
|
277
277
|
'location'?: AppBarDTOLocationEnum;
|
|
278
278
|
/**
|
|
@@ -310,6 +310,7 @@ export declare const AppBarDTOLocationEnum: {
|
|
|
310
310
|
readonly RecordDetail: "RECORD_DETAIL";
|
|
311
311
|
readonly ToolBar: "TOOL_BAR";
|
|
312
312
|
readonly TraitBar: "TRAIT_BAR";
|
|
313
|
+
readonly RecordTrait: "RECORD_TRAIT";
|
|
313
314
|
};
|
|
314
315
|
export type AppBarDTOLocationEnum = typeof AppBarDTOLocationEnum[keyof typeof AppBarDTOLocationEnum];
|
|
315
316
|
/**
|
|
@@ -384,6 +385,7 @@ export interface AppBarTriggerRequest {
|
|
|
384
385
|
export interface AppBarVisibilityEntry {
|
|
385
386
|
'objects'?: Array<string>;
|
|
386
387
|
'suites'?: Array<string>;
|
|
388
|
+
'traits'?: Array<string>;
|
|
387
389
|
}
|
|
388
390
|
export interface AppConnectionStatusDTO {
|
|
389
391
|
'id'?: string;
|
|
@@ -2066,8 +2068,8 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2066
2068
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2067
2069
|
export interface ExistingWidgetSummary {
|
|
2068
2070
|
'ymetric'?: string;
|
|
2069
|
-
'yproperty'?: string;
|
|
2070
2071
|
'xproperty'?: string;
|
|
2072
|
+
'yproperty'?: string;
|
|
2071
2073
|
'title'?: string;
|
|
2072
2074
|
'chartType'?: string;
|
|
2073
2075
|
'xProperty'?: string;
|
|
@@ -6378,6 +6380,7 @@ export declare const ListAppBarsLocationEnum: {
|
|
|
6378
6380
|
readonly RecordDetail: "RECORD_DETAIL";
|
|
6379
6381
|
readonly ToolBar: "TOOL_BAR";
|
|
6380
6382
|
readonly TraitBar: "TRAIT_BAR";
|
|
6383
|
+
readonly RecordTrait: "RECORD_TRAIT";
|
|
6381
6384
|
};
|
|
6382
6385
|
export type ListAppBarsLocationEnum = typeof ListAppBarsLocationEnum[keyof typeof ListAppBarsLocationEnum];
|
|
6383
6386
|
/**
|
package/dist/api.js
CHANGED
|
@@ -53,6 +53,7 @@ exports.AppBarDTOLocationEnum = {
|
|
|
53
53
|
RecordDetail: 'RECORD_DETAIL',
|
|
54
54
|
ToolBar: 'TOOL_BAR',
|
|
55
55
|
TraitBar: 'TRAIT_BAR',
|
|
56
|
+
RecordTrait: 'RECORD_TRAIT',
|
|
56
57
|
};
|
|
57
58
|
exports.AppDTOAuthMethodEnum = {
|
|
58
59
|
ApiKey: 'API_KEY',
|
|
@@ -507,6 +508,7 @@ exports.ListAppBarsLocationEnum = {
|
|
|
507
508
|
RecordDetail: 'RECORD_DETAIL',
|
|
508
509
|
ToolBar: 'TOOL_BAR',
|
|
509
510
|
TraitBar: 'TRAIT_BAR',
|
|
511
|
+
RecordTrait: 'RECORD_TRAIT',
|
|
510
512
|
};
|
|
511
513
|
/**
|
|
512
514
|
* AppInstallationRuntimeApi - axios parameter creator
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -272,7 +272,7 @@ export interface AppBarDTO {
|
|
|
272
272
|
*/
|
|
273
273
|
'index'?: number;
|
|
274
274
|
/**
|
|
275
|
-
* Bar location: RECORD_PREVIEW, RECORD_OVERVIEW, RECORD_DETAIL, TOOL_BAR, TRAIT_BAR
|
|
275
|
+
* Bar location: RECORD_PREVIEW, RECORD_OVERVIEW, RECORD_DETAIL, TOOL_BAR, TRAIT_BAR, RECORD_TRAIT
|
|
276
276
|
*/
|
|
277
277
|
'location'?: AppBarDTOLocationEnum;
|
|
278
278
|
/**
|
|
@@ -310,6 +310,7 @@ export declare const AppBarDTOLocationEnum: {
|
|
|
310
310
|
readonly RecordDetail: "RECORD_DETAIL";
|
|
311
311
|
readonly ToolBar: "TOOL_BAR";
|
|
312
312
|
readonly TraitBar: "TRAIT_BAR";
|
|
313
|
+
readonly RecordTrait: "RECORD_TRAIT";
|
|
313
314
|
};
|
|
314
315
|
export type AppBarDTOLocationEnum = typeof AppBarDTOLocationEnum[keyof typeof AppBarDTOLocationEnum];
|
|
315
316
|
/**
|
|
@@ -384,6 +385,7 @@ export interface AppBarTriggerRequest {
|
|
|
384
385
|
export interface AppBarVisibilityEntry {
|
|
385
386
|
'objects'?: Array<string>;
|
|
386
387
|
'suites'?: Array<string>;
|
|
388
|
+
'traits'?: Array<string>;
|
|
387
389
|
}
|
|
388
390
|
export interface AppConnectionStatusDTO {
|
|
389
391
|
'id'?: string;
|
|
@@ -2066,8 +2068,8 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2066
2068
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2067
2069
|
export interface ExistingWidgetSummary {
|
|
2068
2070
|
'ymetric'?: string;
|
|
2069
|
-
'yproperty'?: string;
|
|
2070
2071
|
'xproperty'?: string;
|
|
2072
|
+
'yproperty'?: string;
|
|
2071
2073
|
'title'?: string;
|
|
2072
2074
|
'chartType'?: string;
|
|
2073
2075
|
'xProperty'?: string;
|
|
@@ -6378,6 +6380,7 @@ export declare const ListAppBarsLocationEnum: {
|
|
|
6378
6380
|
readonly RecordDetail: "RECORD_DETAIL";
|
|
6379
6381
|
readonly ToolBar: "TOOL_BAR";
|
|
6380
6382
|
readonly TraitBar: "TRAIT_BAR";
|
|
6383
|
+
readonly RecordTrait: "RECORD_TRAIT";
|
|
6381
6384
|
};
|
|
6382
6385
|
export type ListAppBarsLocationEnum = typeof ListAppBarsLocationEnum[keyof typeof ListAppBarsLocationEnum];
|
|
6383
6386
|
/**
|
package/dist/esm/api.js
CHANGED
|
@@ -48,6 +48,7 @@ export const AppBarDTOLocationEnum = {
|
|
|
48
48
|
RecordDetail: 'RECORD_DETAIL',
|
|
49
49
|
ToolBar: 'TOOL_BAR',
|
|
50
50
|
TraitBar: 'TRAIT_BAR',
|
|
51
|
+
RecordTrait: 'RECORD_TRAIT',
|
|
51
52
|
};
|
|
52
53
|
export const AppDTOAuthMethodEnum = {
|
|
53
54
|
ApiKey: 'API_KEY',
|
|
@@ -494,6 +495,7 @@ export const ListAppBarsLocationEnum = {
|
|
|
494
495
|
RecordDetail: 'RECORD_DETAIL',
|
|
495
496
|
ToolBar: 'TOOL_BAR',
|
|
496
497
|
TraitBar: 'TRAIT_BAR',
|
|
498
|
+
RecordTrait: 'RECORD_TRAIT',
|
|
497
499
|
};
|
|
498
500
|
/**
|
|
499
501
|
* AppInstallationRuntimeApi - axios parameter creator
|
package/docs/AppBarDTO.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
|
-
**location** | **string** | Bar location: RECORD_PREVIEW, RECORD_OVERVIEW, RECORD_DETAIL, TOOL_BAR, TRAIT_BAR | [optional] [default to undefined]
|
|
19
|
+
**location** | **string** | Bar location: RECORD_PREVIEW, RECORD_OVERVIEW, RECORD_DETAIL, TOOL_BAR, TRAIT_BAR, RECORD_TRAIT | [optional] [default to undefined]
|
|
20
20
|
**iframeUrl** | **string** | URL for iframe-based locations (supports {recordUuid}, {object}, {viewId}, {trait}, {companyUuid} placeholders) | [optional] [default to undefined]
|
|
21
21
|
**icon** | **string** | Optional icon name/key for this app bar | [optional] [default to undefined]
|
|
22
22
|
**description** | **string** | Description shown under the dialog title for action-based bars | [optional] [default to undefined]
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**objects** | **Array<string>** | | [optional] [default to undefined]
|
|
9
9
|
**suites** | **Array<string>** | | [optional] [default to undefined]
|
|
10
|
+
**traits** | **Array<string>** | | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import { AppBarVisibilityEntry } from '@caraer/client';
|
|
|
16
17
|
const instance: AppBarVisibilityEntry = {
|
|
17
18
|
objects,
|
|
18
19
|
suites,
|
|
20
|
+
traits,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
21
23
|
|
package/docs/AppBarsApi.md
CHANGED
|
@@ -23,7 +23,7 @@ import {
|
|
|
23
23
|
const configuration = new Configuration();
|
|
24
24
|
const apiInstance = new AppBarsApi(configuration);
|
|
25
25
|
|
|
26
|
-
let location: 'RECORD_PREVIEW' | 'RECORD_OVERVIEW' | 'RECORD_DETAIL' | 'TOOL_BAR' | 'TRAIT_BAR'; //App bar location (default to undefined)
|
|
26
|
+
let location: 'RECORD_PREVIEW' | 'RECORD_OVERVIEW' | 'RECORD_DETAIL' | 'TOOL_BAR' | 'TRAIT_BAR' | 'RECORD_TRAIT'; //App bar location (default to undefined)
|
|
27
27
|
let object: string; //Object name in context (optional) (default to undefined)
|
|
28
28
|
let recordUuid: string; //Record UUID in context (optional) (default to undefined)
|
|
29
29
|
let viewId: string; //View ID in context (optional) (default to undefined)
|
|
@@ -42,7 +42,7 @@ const { status, data } = await apiInstance.listAppBars(
|
|
|
42
42
|
|
|
43
43
|
|Name | Type | Description | Notes|
|
|
44
44
|
|------------- | ------------- | ------------- | -------------|
|
|
45
|
-
| **location** | [**'RECORD_PREVIEW' | 'RECORD_OVERVIEW' | 'RECORD_DETAIL' | 'TOOL_BAR' | 'TRAIT_BAR'**]**Array<'RECORD_PREVIEW' | 'RECORD_OVERVIEW' | 'RECORD_DETAIL' | 'TOOL_BAR' | 'TRAIT_BAR'>** | App bar location | defaults to undefined|
|
|
45
|
+
| **location** | [**'RECORD_PREVIEW' | 'RECORD_OVERVIEW' | 'RECORD_DETAIL' | 'TOOL_BAR' | 'TRAIT_BAR' | 'RECORD_TRAIT'**]**Array<'RECORD_PREVIEW' | 'RECORD_OVERVIEW' | 'RECORD_DETAIL' | 'TOOL_BAR' | 'TRAIT_BAR' | 'RECORD_TRAIT'>** | App bar location | defaults to undefined|
|
|
46
46
|
| **object** | [**string**] | Object name in context | (optional) defaults to undefined|
|
|
47
47
|
| **recordUuid** | [**string**] | Record UUID in context | (optional) defaults to undefined|
|
|
48
48
|
| **viewId** | [**string**] | View ID in context | (optional) defaults to undefined|
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**ymetric** | **string** | | [optional] [default to undefined]
|
|
9
|
-
**yproperty** | **string** | | [optional] [default to undefined]
|
|
10
9
|
**xproperty** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**yproperty** | **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
|
ymetric,
|
|
24
|
-
yproperty,
|
|
25
24
|
xproperty,
|
|
25
|
+
yproperty,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
28
28
|
xProperty,
|