@caraer/client 2.0.694 → 2.0.696
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 +3 -0
- package/api.ts +22 -2
- package/dist/api.d.ts +22 -2
- package/dist/esm/api.d.ts +22 -2
- package/docs/Audience.md +36 -0
- package/docs/CRUD.md +2 -0
- package/docs/CrudAccessContext.md +22 -0
- package/docs/Permissions.md +22 -0
- package/docs/Record.md +2 -2
- package/docs/SettingField.md +2 -2
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -52,6 +52,7 @@ docs/AppSettingsSection.md
|
|
|
52
52
|
docs/AppSubcategoryDTO.md
|
|
53
53
|
docs/ApplicationsApi.md
|
|
54
54
|
docs/ArchivedRecordObjectDTO.md
|
|
55
|
+
docs/Audience.md
|
|
55
56
|
docs/AutomationsApi.md
|
|
56
57
|
docs/BillingApi.md
|
|
57
58
|
docs/BillingSettingsDTO.md
|
|
@@ -110,6 +111,7 @@ docs/CreateResponseSignedUrlResultDTO.md
|
|
|
110
111
|
docs/CreateSignedUrlRequest.md
|
|
111
112
|
docs/CriterionScore.md
|
|
112
113
|
docs/CrossObjectRecordSearchRequest.md
|
|
114
|
+
docs/CrudAccessContext.md
|
|
113
115
|
docs/Currency.md
|
|
114
116
|
docs/CurrencyRange.md
|
|
115
117
|
docs/CursorLocation.md
|
|
@@ -213,6 +215,7 @@ docs/PaginationResponseTraitDTO.md
|
|
|
213
215
|
docs/PaginationResponseViewDTO.md
|
|
214
216
|
docs/PaginationResponseWebMenuDTO.md
|
|
215
217
|
docs/PaginationResponseWebpageAccessGrantDTO.md
|
|
218
|
+
docs/Permissions.md
|
|
216
219
|
docs/Phone.md
|
|
217
220
|
docs/PreviewDTO.md
|
|
218
221
|
docs/PreviewItemDTO.md
|
package/api.ts
CHANGED
|
@@ -1064,6 +1064,17 @@ export interface ArchivedRecordObjectDTO {
|
|
|
1064
1064
|
'icon'?: string;
|
|
1065
1065
|
'index'?: number;
|
|
1066
1066
|
}
|
|
1067
|
+
export interface Audience {
|
|
1068
|
+
'authentication'?: any;
|
|
1069
|
+
'principal'?: any;
|
|
1070
|
+
'authenticated'?: boolean;
|
|
1071
|
+
'database'?: string;
|
|
1072
|
+
'principalDatabase'?: string;
|
|
1073
|
+
'companyUuid'?: string;
|
|
1074
|
+
'principalUuid'?: string;
|
|
1075
|
+
'authorities'?: Array<string>;
|
|
1076
|
+
'roles'?: Array<string>;
|
|
1077
|
+
}
|
|
1067
1078
|
/**
|
|
1068
1079
|
* The billing settings of the company.
|
|
1069
1080
|
*/
|
|
@@ -1269,6 +1280,7 @@ export interface BulkEditRecordsResponse {
|
|
|
1269
1280
|
export interface CRUD {
|
|
1270
1281
|
'httpSessionId'?: string;
|
|
1271
1282
|
'turnOffMetaRelationships'?: boolean;
|
|
1283
|
+
'httpAccessContext'?: CrudAccessContext;
|
|
1272
1284
|
}
|
|
1273
1285
|
export interface CalendarBootstrapDTO {
|
|
1274
1286
|
'defaultCalendar'?: CalendarRecordDTO;
|
|
@@ -2187,6 +2199,10 @@ export interface CrossObjectRecordSearchRequest {
|
|
|
2187
2199
|
*/
|
|
2188
2200
|
'excludeRecordUuid'?: string;
|
|
2189
2201
|
}
|
|
2202
|
+
export interface CrudAccessContext {
|
|
2203
|
+
'audience'?: Audience;
|
|
2204
|
+
'permissions'?: Permissions;
|
|
2205
|
+
}
|
|
2190
2206
|
export interface Currency extends PropertyFormat {
|
|
2191
2207
|
}
|
|
2192
2208
|
export interface CurrencyRange extends PropertyFormat {
|
|
@@ -3740,9 +3756,9 @@ export interface ModelRecord {
|
|
|
3740
3756
|
'complete'?: boolean;
|
|
3741
3757
|
'deleted'?: boolean;
|
|
3742
3758
|
'uuid': string;
|
|
3759
|
+
'user'?: PublicUserDTO;
|
|
3743
3760
|
'properties'?: Array<FilledProperty>;
|
|
3744
3761
|
'objects'?: { [key: string]: any | null; };
|
|
3745
|
-
'user'?: PublicUserDTO;
|
|
3746
3762
|
}
|
|
3747
3763
|
export interface MultiFile extends PropertyFormat {
|
|
3748
3764
|
}
|
|
@@ -4637,6 +4653,10 @@ export interface PaginationResponseWebpageAccessGrantDTO {
|
|
|
4637
4653
|
*/
|
|
4638
4654
|
'lastPage'?: number;
|
|
4639
4655
|
}
|
|
4656
|
+
export interface Permissions {
|
|
4657
|
+
'scopes'?: Array<string>;
|
|
4658
|
+
'filters'?: any;
|
|
4659
|
+
}
|
|
4640
4660
|
export interface Phone extends PropertyFormat {
|
|
4641
4661
|
}
|
|
4642
4662
|
/**
|
|
@@ -5986,8 +6006,8 @@ export interface SettingField {
|
|
|
5986
6006
|
'hidden'?: boolean;
|
|
5987
6007
|
'disabled'?: boolean;
|
|
5988
6008
|
'options'?: Array<SettingOption>;
|
|
5989
|
-
'value'?: any;
|
|
5990
6009
|
'defaultValue'?: any;
|
|
6010
|
+
'value'?: any;
|
|
5991
6011
|
}
|
|
5992
6012
|
|
|
5993
6013
|
export const SettingFieldTypeEnum = {
|
package/dist/api.d.ts
CHANGED
|
@@ -1055,6 +1055,17 @@ export interface ArchivedRecordObjectDTO {
|
|
|
1055
1055
|
'icon'?: string;
|
|
1056
1056
|
'index'?: number;
|
|
1057
1057
|
}
|
|
1058
|
+
export interface Audience {
|
|
1059
|
+
'authentication'?: any;
|
|
1060
|
+
'principal'?: any;
|
|
1061
|
+
'authenticated'?: boolean;
|
|
1062
|
+
'database'?: string;
|
|
1063
|
+
'principalDatabase'?: string;
|
|
1064
|
+
'companyUuid'?: string;
|
|
1065
|
+
'principalUuid'?: string;
|
|
1066
|
+
'authorities'?: Array<string>;
|
|
1067
|
+
'roles'?: Array<string>;
|
|
1068
|
+
}
|
|
1058
1069
|
/**
|
|
1059
1070
|
* The billing settings of the company.
|
|
1060
1071
|
*/
|
|
@@ -1262,6 +1273,7 @@ export interface BulkEditRecordsResponse {
|
|
|
1262
1273
|
export interface CRUD {
|
|
1263
1274
|
'httpSessionId'?: string;
|
|
1264
1275
|
'turnOffMetaRelationships'?: boolean;
|
|
1276
|
+
'httpAccessContext'?: CrudAccessContext;
|
|
1265
1277
|
}
|
|
1266
1278
|
export interface CalendarBootstrapDTO {
|
|
1267
1279
|
'defaultCalendar'?: CalendarRecordDTO;
|
|
@@ -2190,6 +2202,10 @@ export interface CrossObjectRecordSearchRequest {
|
|
|
2190
2202
|
*/
|
|
2191
2203
|
'excludeRecordUuid'?: string;
|
|
2192
2204
|
}
|
|
2205
|
+
export interface CrudAccessContext {
|
|
2206
|
+
'audience'?: Audience;
|
|
2207
|
+
'permissions'?: Permissions;
|
|
2208
|
+
}
|
|
2193
2209
|
export interface Currency extends PropertyFormat {
|
|
2194
2210
|
}
|
|
2195
2211
|
export interface CurrencyRange extends PropertyFormat {
|
|
@@ -3754,11 +3770,11 @@ export interface ModelRecord {
|
|
|
3754
3770
|
'complete'?: boolean;
|
|
3755
3771
|
'deleted'?: boolean;
|
|
3756
3772
|
'uuid': string;
|
|
3773
|
+
'user'?: PublicUserDTO;
|
|
3757
3774
|
'properties'?: Array<FilledProperty>;
|
|
3758
3775
|
'objects'?: {
|
|
3759
3776
|
[key: string]: any | null;
|
|
3760
3777
|
};
|
|
3761
|
-
'user'?: PublicUserDTO;
|
|
3762
3778
|
}
|
|
3763
3779
|
export interface MultiFile extends PropertyFormat {
|
|
3764
3780
|
}
|
|
@@ -4664,6 +4680,10 @@ export interface PaginationResponseWebpageAccessGrantDTO {
|
|
|
4664
4680
|
*/
|
|
4665
4681
|
'lastPage'?: number;
|
|
4666
4682
|
}
|
|
4683
|
+
export interface Permissions {
|
|
4684
|
+
'scopes'?: Array<string>;
|
|
4685
|
+
'filters'?: any;
|
|
4686
|
+
}
|
|
4667
4687
|
export interface Phone extends PropertyFormat {
|
|
4668
4688
|
}
|
|
4669
4689
|
/**
|
|
@@ -6038,8 +6058,8 @@ export interface SettingField {
|
|
|
6038
6058
|
'hidden'?: boolean;
|
|
6039
6059
|
'disabled'?: boolean;
|
|
6040
6060
|
'options'?: Array<SettingOption>;
|
|
6041
|
-
'value'?: any;
|
|
6042
6061
|
'defaultValue'?: any;
|
|
6062
|
+
'value'?: any;
|
|
6043
6063
|
}
|
|
6044
6064
|
export declare const SettingFieldTypeEnum: {
|
|
6045
6065
|
readonly String: "STRING";
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1054,6 +1054,17 @@ export interface ArchivedRecordObjectDTO {
|
|
|
1054
1054
|
'icon'?: string;
|
|
1055
1055
|
'index'?: number;
|
|
1056
1056
|
}
|
|
1057
|
+
export interface Audience {
|
|
1058
|
+
'authentication'?: any;
|
|
1059
|
+
'principal'?: any;
|
|
1060
|
+
'authenticated'?: boolean;
|
|
1061
|
+
'database'?: string;
|
|
1062
|
+
'principalDatabase'?: string;
|
|
1063
|
+
'companyUuid'?: string;
|
|
1064
|
+
'principalUuid'?: string;
|
|
1065
|
+
'authorities'?: Array<string>;
|
|
1066
|
+
'roles'?: Array<string>;
|
|
1067
|
+
}
|
|
1057
1068
|
/**
|
|
1058
1069
|
* The billing settings of the company.
|
|
1059
1070
|
*/
|
|
@@ -1261,6 +1272,7 @@ export interface BulkEditRecordsResponse {
|
|
|
1261
1272
|
export interface CRUD {
|
|
1262
1273
|
'httpSessionId'?: string;
|
|
1263
1274
|
'turnOffMetaRelationships'?: boolean;
|
|
1275
|
+
'httpAccessContext'?: CrudAccessContext;
|
|
1264
1276
|
}
|
|
1265
1277
|
export interface CalendarBootstrapDTO {
|
|
1266
1278
|
'defaultCalendar'?: CalendarRecordDTO;
|
|
@@ -2189,6 +2201,10 @@ export interface CrossObjectRecordSearchRequest {
|
|
|
2189
2201
|
*/
|
|
2190
2202
|
'excludeRecordUuid'?: string;
|
|
2191
2203
|
}
|
|
2204
|
+
export interface CrudAccessContext {
|
|
2205
|
+
'audience'?: Audience;
|
|
2206
|
+
'permissions'?: Permissions;
|
|
2207
|
+
}
|
|
2192
2208
|
export interface Currency extends PropertyFormat {
|
|
2193
2209
|
}
|
|
2194
2210
|
export interface CurrencyRange extends PropertyFormat {
|
|
@@ -3753,11 +3769,11 @@ export interface ModelRecord {
|
|
|
3753
3769
|
'complete'?: boolean;
|
|
3754
3770
|
'deleted'?: boolean;
|
|
3755
3771
|
'uuid': string;
|
|
3772
|
+
'user'?: PublicUserDTO;
|
|
3756
3773
|
'properties'?: Array<FilledProperty>;
|
|
3757
3774
|
'objects'?: {
|
|
3758
3775
|
[key: string]: any | null;
|
|
3759
3776
|
};
|
|
3760
|
-
'user'?: PublicUserDTO;
|
|
3761
3777
|
}
|
|
3762
3778
|
export interface MultiFile extends PropertyFormat {
|
|
3763
3779
|
}
|
|
@@ -4663,6 +4679,10 @@ export interface PaginationResponseWebpageAccessGrantDTO {
|
|
|
4663
4679
|
*/
|
|
4664
4680
|
'lastPage'?: number;
|
|
4665
4681
|
}
|
|
4682
|
+
export interface Permissions {
|
|
4683
|
+
'scopes'?: Array<string>;
|
|
4684
|
+
'filters'?: any;
|
|
4685
|
+
}
|
|
4666
4686
|
export interface Phone extends PropertyFormat {
|
|
4667
4687
|
}
|
|
4668
4688
|
/**
|
|
@@ -6037,8 +6057,8 @@ export interface SettingField {
|
|
|
6037
6057
|
'hidden'?: boolean;
|
|
6038
6058
|
'disabled'?: boolean;
|
|
6039
6059
|
'options'?: Array<SettingOption>;
|
|
6040
|
-
'value'?: any;
|
|
6041
6060
|
'defaultValue'?: any;
|
|
6061
|
+
'value'?: any;
|
|
6042
6062
|
}
|
|
6043
6063
|
export declare const SettingFieldTypeEnum: {
|
|
6044
6064
|
readonly String: "STRING";
|
package/docs/Audience.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Audience
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**authentication** | **any** | | [optional] [default to undefined]
|
|
9
|
+
**principal** | **any** | | [optional] [default to undefined]
|
|
10
|
+
**authenticated** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**database** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**principalDatabase** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**companyUuid** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**principalUuid** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**authorities** | **Array<string>** | | [optional] [default to undefined]
|
|
16
|
+
**roles** | **Array<string>** | | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { Audience } from '@caraer/client';
|
|
22
|
+
|
|
23
|
+
const instance: Audience = {
|
|
24
|
+
authentication,
|
|
25
|
+
principal,
|
|
26
|
+
authenticated,
|
|
27
|
+
database,
|
|
28
|
+
principalDatabase,
|
|
29
|
+
companyUuid,
|
|
30
|
+
principalUuid,
|
|
31
|
+
authorities,
|
|
32
|
+
roles,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[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/CRUD.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**httpSessionId** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**turnOffMetaRelationships** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
**httpAccessContext** | [**CrudAccessContext**](CrudAccessContext.md) | | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import { CRUD } from '@caraer/client';
|
|
|
16
17
|
const instance: CRUD = {
|
|
17
18
|
httpSessionId,
|
|
18
19
|
turnOffMetaRelationships,
|
|
20
|
+
httpAccessContext,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
21
23
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CrudAccessContext
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**audience** | [**Audience**](Audience.md) | | [optional] [default to undefined]
|
|
9
|
+
**permissions** | [**Permissions**](Permissions.md) | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { CrudAccessContext } from '@caraer/client';
|
|
15
|
+
|
|
16
|
+
const instance: CrudAccessContext = {
|
|
17
|
+
audience,
|
|
18
|
+
permissions,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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,22 @@
|
|
|
1
|
+
# Permissions
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**scopes** | **Array<string>** | | [optional] [default to undefined]
|
|
9
|
+
**filters** | **any** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { Permissions } from '@caraer/client';
|
|
15
|
+
|
|
16
|
+
const instance: Permissions = {
|
|
17
|
+
scopes,
|
|
18
|
+
filters,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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
|
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**complete** | **boolean** | | [optional] [default to undefined]
|
|
18
18
|
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**uuid** | **string** | | [default to undefined]
|
|
20
|
+
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
20
21
|
**properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
|
|
21
22
|
**objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
22
|
-
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
|
@@ -39,9 +39,9 @@ const instance: ModelRecord = {
|
|
|
39
39
|
complete,
|
|
40
40
|
deleted,
|
|
41
41
|
uuid,
|
|
42
|
+
user,
|
|
42
43
|
properties,
|
|
43
44
|
objects,
|
|
44
|
-
user,
|
|
45
45
|
};
|
|
46
46
|
```
|
|
47
47
|
|
package/docs/SettingField.md
CHANGED
|
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**hidden** | **boolean** | | [optional] [default to undefined]
|
|
15
15
|
**disabled** | **boolean** | | [optional] [default to undefined]
|
|
16
16
|
**_options** | [**Array<SettingOption>**](SettingOption.md) | | [optional] [default to undefined]
|
|
17
|
-
**value** | **any** | | [optional] [default to undefined]
|
|
18
17
|
**defaultValue** | **any** | | [optional] [default to undefined]
|
|
18
|
+
**value** | **any** | | [optional] [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -32,8 +32,8 @@ const instance: SettingField = {
|
|
|
32
32
|
hidden,
|
|
33
33
|
disabled,
|
|
34
34
|
_options,
|
|
35
|
-
value,
|
|
36
35
|
defaultValue,
|
|
36
|
+
value,
|
|
37
37
|
};
|
|
38
38
|
```
|
|
39
39
|
|