@caraer/client 2.0.395 → 2.0.397

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.
@@ -41,6 +41,7 @@ docs/AppPricingDTO.md
41
41
  docs/AppPublishDTO.md
42
42
  docs/AppRequest.md
43
43
  docs/AppScheduleDTO.md
44
+ docs/AppSettingCondition.md
44
45
  docs/AppSettingFieldMappingStructure.md
45
46
  docs/AppSettingFieldMappingStructureItem.md
46
47
  docs/AppSettingFieldSchema.md
package/api.ts CHANGED
@@ -1017,6 +1017,11 @@ export interface AppScheduleDTO {
1017
1017
  'payloadTemplate'?: string;
1018
1018
  'serverlessFunction'?: ServerlessFunctionRefDTO;
1019
1019
  }
1020
+ export interface AppSettingCondition {
1021
+ 'field'?: string;
1022
+ 'operator'?: string;
1023
+ 'value'?: any;
1024
+ }
1020
1025
  export interface AppSettingFieldMappingStructure {
1021
1026
  'objectName'?: string;
1022
1027
  'items'?: Array<AppSettingFieldMappingStructureItem>;
@@ -1040,6 +1045,7 @@ export interface AppSettingFieldSchema {
1040
1045
  'optionsSource'?: AppSettingOptionsSource;
1041
1046
  'defaultValue'?: any;
1042
1047
  'hidden'?: boolean;
1048
+ 'visibleWhen'?: Array<AppSettingCondition>;
1043
1049
  'value'?: any;
1044
1050
  'hasValue'?: boolean;
1045
1051
  'mappingValue'?: AppSettingFieldMappingStructure;
@@ -2834,6 +2840,14 @@ export interface LoadAppSettingOptionsRequest {
2834
2840
  * When loading options for an app bar field, the app bar UUID.
2835
2841
  */
2836
2842
  'appBarUuid'?: string;
2843
+ /**
2844
+ * Record in context when the options field is on an action dialog.
2845
+ */
2846
+ 'recordUuid'?: string;
2847
+ /**
2848
+ * Object name in context when the options field is on an action dialog.
2849
+ */
2850
+ 'object'?: string;
2837
2851
  }
2838
2852
  export interface LoginRequest {
2839
2853
  'email': string;
@@ -2959,9 +2973,9 @@ export interface ModelRecord {
2959
2973
  'deleted'?: boolean;
2960
2974
  'complete'?: boolean;
2961
2975
  'uuid': string;
2962
- 'user'?: PublicUserDTO;
2963
2976
  'properties'?: Array<FilledProperty>;
2964
2977
  'objects'?: { [key: string]: any | null; };
2978
+ 'user'?: PublicUserDTO;
2965
2979
  }
2966
2980
  export interface MultiLine extends PropertyFormat {
2967
2981
  }
@@ -4474,8 +4488,8 @@ export interface SettingField {
4474
4488
  'hidden'?: boolean;
4475
4489
  'disabled'?: boolean;
4476
4490
  'options'?: Array<SettingOption>;
4477
- 'value'?: any;
4478
4491
  'defaultValue'?: any;
4492
+ 'value'?: any;
4479
4493
  }
4480
4494
 
4481
4495
  export const SettingFieldTypeEnum = {
package/dist/api.d.ts CHANGED
@@ -1007,6 +1007,11 @@ export interface AppScheduleDTO {
1007
1007
  'payloadTemplate'?: string;
1008
1008
  'serverlessFunction'?: ServerlessFunctionRefDTO;
1009
1009
  }
1010
+ export interface AppSettingCondition {
1011
+ 'field'?: string;
1012
+ 'operator'?: string;
1013
+ 'value'?: any;
1014
+ }
1010
1015
  export interface AppSettingFieldMappingStructure {
1011
1016
  'objectName'?: string;
1012
1017
  'items'?: Array<AppSettingFieldMappingStructureItem>;
@@ -1030,6 +1035,7 @@ export interface AppSettingFieldSchema {
1030
1035
  'optionsSource'?: AppSettingOptionsSource;
1031
1036
  'defaultValue'?: any;
1032
1037
  'hidden'?: boolean;
1038
+ 'visibleWhen'?: Array<AppSettingCondition>;
1033
1039
  'value'?: any;
1034
1040
  'hasValue'?: boolean;
1035
1041
  'mappingValue'?: AppSettingFieldMappingStructure;
@@ -2827,6 +2833,14 @@ export interface LoadAppSettingOptionsRequest {
2827
2833
  * When loading options for an app bar field, the app bar UUID.
2828
2834
  */
2829
2835
  'appBarUuid'?: string;
2836
+ /**
2837
+ * Record in context when the options field is on an action dialog.
2838
+ */
2839
+ 'recordUuid'?: string;
2840
+ /**
2841
+ * Object name in context when the options field is on an action dialog.
2842
+ */
2843
+ 'object'?: string;
2830
2844
  }
2831
2845
  export interface LoginRequest {
2832
2846
  'email': string;
@@ -2952,11 +2966,11 @@ export interface ModelRecord {
2952
2966
  'deleted'?: boolean;
2953
2967
  'complete'?: boolean;
2954
2968
  'uuid': string;
2955
- 'user'?: PublicUserDTO;
2956
2969
  'properties'?: Array<FilledProperty>;
2957
2970
  'objects'?: {
2958
2971
  [key: string]: any | null;
2959
2972
  };
2973
+ 'user'?: PublicUserDTO;
2960
2974
  }
2961
2975
  export interface MultiLine extends PropertyFormat {
2962
2976
  }
@@ -4497,8 +4511,8 @@ export interface SettingField {
4497
4511
  'hidden'?: boolean;
4498
4512
  'disabled'?: boolean;
4499
4513
  'options'?: Array<SettingOption>;
4500
- 'value'?: any;
4501
4514
  'defaultValue'?: any;
4515
+ 'value'?: any;
4502
4516
  }
4503
4517
  export declare const SettingFieldTypeEnum: {
4504
4518
  readonly String: "STRING";
package/dist/esm/api.d.ts CHANGED
@@ -1007,6 +1007,11 @@ export interface AppScheduleDTO {
1007
1007
  'payloadTemplate'?: string;
1008
1008
  'serverlessFunction'?: ServerlessFunctionRefDTO;
1009
1009
  }
1010
+ export interface AppSettingCondition {
1011
+ 'field'?: string;
1012
+ 'operator'?: string;
1013
+ 'value'?: any;
1014
+ }
1010
1015
  export interface AppSettingFieldMappingStructure {
1011
1016
  'objectName'?: string;
1012
1017
  'items'?: Array<AppSettingFieldMappingStructureItem>;
@@ -1030,6 +1035,7 @@ export interface AppSettingFieldSchema {
1030
1035
  'optionsSource'?: AppSettingOptionsSource;
1031
1036
  'defaultValue'?: any;
1032
1037
  'hidden'?: boolean;
1038
+ 'visibleWhen'?: Array<AppSettingCondition>;
1033
1039
  'value'?: any;
1034
1040
  'hasValue'?: boolean;
1035
1041
  'mappingValue'?: AppSettingFieldMappingStructure;
@@ -2827,6 +2833,14 @@ export interface LoadAppSettingOptionsRequest {
2827
2833
  * When loading options for an app bar field, the app bar UUID.
2828
2834
  */
2829
2835
  'appBarUuid'?: string;
2836
+ /**
2837
+ * Record in context when the options field is on an action dialog.
2838
+ */
2839
+ 'recordUuid'?: string;
2840
+ /**
2841
+ * Object name in context when the options field is on an action dialog.
2842
+ */
2843
+ 'object'?: string;
2830
2844
  }
2831
2845
  export interface LoginRequest {
2832
2846
  'email': string;
@@ -2952,11 +2966,11 @@ export interface ModelRecord {
2952
2966
  'deleted'?: boolean;
2953
2967
  'complete'?: boolean;
2954
2968
  'uuid': string;
2955
- 'user'?: PublicUserDTO;
2956
2969
  'properties'?: Array<FilledProperty>;
2957
2970
  'objects'?: {
2958
2971
  [key: string]: any | null;
2959
2972
  };
2973
+ 'user'?: PublicUserDTO;
2960
2974
  }
2961
2975
  export interface MultiLine extends PropertyFormat {
2962
2976
  }
@@ -4497,8 +4511,8 @@ export interface SettingField {
4497
4511
  'hidden'?: boolean;
4498
4512
  'disabled'?: boolean;
4499
4513
  'options'?: Array<SettingOption>;
4500
- 'value'?: any;
4501
4514
  'defaultValue'?: any;
4515
+ 'value'?: any;
4502
4516
  }
4503
4517
  export declare const SettingFieldTypeEnum: {
4504
4518
  readonly String: "STRING";
@@ -0,0 +1,24 @@
1
+ # AppSettingCondition
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **field** | **string** | | [optional] [default to undefined]
9
+ **operator** | **string** | | [optional] [default to undefined]
10
+ **value** | **any** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { AppSettingCondition } from '@caraer/client';
16
+
17
+ const instance: AppSettingCondition = {
18
+ field,
19
+ operator,
20
+ value,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
14
14
  **optionsSource** | [**AppSettingOptionsSource**](AppSettingOptionsSource.md) | | [optional] [default to undefined]
15
15
  **defaultValue** | **any** | | [optional] [default to undefined]
16
16
  **hidden** | **boolean** | | [optional] [default to undefined]
17
+ **visibleWhen** | [**Array&lt;AppSettingCondition&gt;**](AppSettingCondition.md) | | [optional] [default to undefined]
17
18
  **value** | **any** | | [optional] [default to undefined]
18
19
  **hasValue** | **boolean** | | [optional] [default to undefined]
19
20
  **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) | | [optional] [default to undefined]
@@ -34,6 +35,7 @@ const instance: AppSettingFieldSchema = {
34
35
  optionsSource,
35
36
  defaultValue,
36
37
  hidden,
38
+ visibleWhen,
37
39
  value,
38
40
  hasValue,
39
41
  mappingValue,
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
10
10
  **query** | **string** | Optional search query typed by the installer. | [optional] [default to undefined]
11
11
  **settingsSchema** | [**Array&lt;AppSettingFieldSchema&gt;**](AppSettingFieldSchema.md) | Current draft settings schema with values from the installer UI. | [default to undefined]
12
12
  **appBarUuid** | **string** | When loading options for an app bar field, the app bar UUID. | [optional] [default to undefined]
13
+ **recordUuid** | **string** | Record in context when the options field is on an action dialog. | [optional] [default to undefined]
14
+ **object** | **string** | Object name in context when the options field is on an action dialog. | [optional] [default to undefined]
13
15
 
14
16
  ## Example
15
17
 
@@ -21,6 +23,8 @@ const instance: LoadAppSettingOptionsRequest = {
21
23
  query,
22
24
  settingsSchema,
23
25
  appBarUuid,
26
+ recordUuid,
27
+ object,
24
28
  };
25
29
  ```
26
30
 
package/docs/Record.md CHANGED
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
17
17
  **deleted** | **boolean** | | [optional] [default to undefined]
18
18
  **complete** | **boolean** | | [optional] [default to undefined]
19
19
  **uuid** | **string** | | [default to undefined]
20
- **user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
21
20
  **properties** | [**Array&lt;FilledProperty&gt;**](FilledProperty.md) | | [optional] [default to undefined]
22
21
  **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
  deleted,
40
40
  complete,
41
41
  uuid,
42
- user,
43
42
  properties,
44
43
  objects,
44
+ user,
45
45
  };
46
46
  ```
47
47
 
@@ -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&lt;SettingOption&gt;**](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
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.395",
3
+ "version": "2.0.397",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {