@epilot/entity-client 4.20.2 → 4.20.4
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/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +27 -12
- package/dist/openapi.d.ts +359 -175
- package/dist/openapi.json +269 -59
- package/package.json +2 -2
package/dist/openapi.d.ts
CHANGED
|
@@ -31,6 +31,12 @@ declare namespace Components {
|
|
|
31
31
|
* contact
|
|
32
32
|
*/
|
|
33
33
|
Schemas.EntitySlug;
|
|
34
|
+
/**
|
|
35
|
+
* URL-friendly identifier for the entity schema
|
|
36
|
+
* example:
|
|
37
|
+
* price
|
|
38
|
+
*/
|
|
39
|
+
export type EntitySlugPathPriceParam = string;
|
|
34
40
|
export type ExcludeSchemasQueryParam = /**
|
|
35
41
|
* URL-friendly identifier for the entity schema
|
|
36
42
|
* example:
|
|
@@ -54,6 +60,12 @@ declare namespace Components {
|
|
|
54
60
|
export interface PathParameters {
|
|
55
61
|
EntityIdPathParam?: Parameters.EntityIdPathParam;
|
|
56
62
|
EntitySlugPathParam?: Parameters.EntitySlugPathParam;
|
|
63
|
+
EntitySlugPathPriceParam?: /**
|
|
64
|
+
* URL-friendly identifier for the entity schema
|
|
65
|
+
* example:
|
|
66
|
+
* price
|
|
67
|
+
*/
|
|
68
|
+
Parameters.EntitySlugPathPriceParam;
|
|
57
69
|
TaxonomySlugPathParam?: Parameters.TaxonomySlugPathParam;
|
|
58
70
|
SavedViewIdPathParam?: Parameters.SavedViewIdPathParam;
|
|
59
71
|
ActivityIdPathParam?: Parameters.ActivityIdPathParam;
|
|
@@ -281,11 +293,9 @@ declare namespace Components {
|
|
|
281
293
|
*/
|
|
282
294
|
feature_flag?: string;
|
|
283
295
|
/**
|
|
284
|
-
* This attribute should only be active when the
|
|
285
|
-
* example:
|
|
286
|
-
* MY_SETTING
|
|
296
|
+
* This attribute should only be active when all the settings have the correct value
|
|
287
297
|
*/
|
|
288
|
-
|
|
298
|
+
settings_flag?: SettingFlag[];
|
|
289
299
|
value_formatter?: string;
|
|
290
300
|
preview_value_formatter?: string;
|
|
291
301
|
/**
|
|
@@ -407,11 +417,9 @@ declare namespace Components {
|
|
|
407
417
|
*/
|
|
408
418
|
feature_flag?: string;
|
|
409
419
|
/**
|
|
410
|
-
* This attribute should only be active when the
|
|
411
|
-
* example:
|
|
412
|
-
* MY_SETTING
|
|
420
|
+
* This attribute should only be active when all the settings have the correct value
|
|
413
421
|
*/
|
|
414
|
-
|
|
422
|
+
settings_flag?: SettingFlag[];
|
|
415
423
|
value_formatter?: string;
|
|
416
424
|
preview_value_formatter?: string;
|
|
417
425
|
/**
|
|
@@ -528,11 +536,9 @@ declare namespace Components {
|
|
|
528
536
|
*/
|
|
529
537
|
feature_flag?: string;
|
|
530
538
|
/**
|
|
531
|
-
* This attribute should only be active when the
|
|
532
|
-
* example:
|
|
533
|
-
* MY_SETTING
|
|
539
|
+
* This attribute should only be active when all the settings have the correct value
|
|
534
540
|
*/
|
|
535
|
-
|
|
541
|
+
settings_flag?: SettingFlag[];
|
|
536
542
|
value_formatter?: string;
|
|
537
543
|
preview_value_formatter?: string;
|
|
538
544
|
/**
|
|
@@ -716,11 +722,9 @@ declare namespace Components {
|
|
|
716
722
|
*/
|
|
717
723
|
feature_flag?: string;
|
|
718
724
|
/**
|
|
719
|
-
* This attribute should only be active when the
|
|
720
|
-
* example:
|
|
721
|
-
* MY_SETTING
|
|
725
|
+
* This attribute should only be active when all the settings have the correct value
|
|
722
726
|
*/
|
|
723
|
-
|
|
727
|
+
settings_flag?: SettingFlag[];
|
|
724
728
|
value_formatter?: string;
|
|
725
729
|
preview_value_formatter?: string;
|
|
726
730
|
/**
|
|
@@ -846,11 +850,9 @@ declare namespace Components {
|
|
|
846
850
|
*/
|
|
847
851
|
feature_flag?: string;
|
|
848
852
|
/**
|
|
849
|
-
* This attribute should only be active when the
|
|
850
|
-
* example:
|
|
851
|
-
* MY_SETTING
|
|
853
|
+
* This attribute should only be active when all the settings have the correct value
|
|
852
854
|
*/
|
|
853
|
-
|
|
855
|
+
settings_flag?: SettingFlag[];
|
|
854
856
|
value_formatter?: string;
|
|
855
857
|
preview_value_formatter?: string;
|
|
856
858
|
/**
|
|
@@ -970,11 +972,9 @@ declare namespace Components {
|
|
|
970
972
|
*/
|
|
971
973
|
feature_flag?: string;
|
|
972
974
|
/**
|
|
973
|
-
* This attribute should only be active when the
|
|
974
|
-
* example:
|
|
975
|
-
* MY_SETTING
|
|
975
|
+
* This attribute should only be active when all the settings have the correct value
|
|
976
976
|
*/
|
|
977
|
-
|
|
977
|
+
settings_flag?: SettingFlag[];
|
|
978
978
|
value_formatter?: string;
|
|
979
979
|
preview_value_formatter?: string;
|
|
980
980
|
/**
|
|
@@ -1096,11 +1096,9 @@ declare namespace Components {
|
|
|
1096
1096
|
*/
|
|
1097
1097
|
feature_flag?: string;
|
|
1098
1098
|
/**
|
|
1099
|
-
* This attribute should only be active when the
|
|
1100
|
-
* example:
|
|
1101
|
-
* MY_SETTING
|
|
1099
|
+
* This attribute should only be active when all the settings have the correct value
|
|
1102
1100
|
*/
|
|
1103
|
-
|
|
1101
|
+
settings_flag?: SettingFlag[];
|
|
1104
1102
|
value_formatter?: string;
|
|
1105
1103
|
preview_value_formatter?: string;
|
|
1106
1104
|
/**
|
|
@@ -1220,11 +1218,9 @@ declare namespace Components {
|
|
|
1220
1218
|
*/
|
|
1221
1219
|
feature_flag?: string;
|
|
1222
1220
|
/**
|
|
1223
|
-
* This attribute should only be active when the
|
|
1224
|
-
* example:
|
|
1225
|
-
* MY_SETTING
|
|
1221
|
+
* This attribute should only be active when all the settings have the correct value
|
|
1226
1222
|
*/
|
|
1227
|
-
|
|
1223
|
+
settings_flag?: SettingFlag[];
|
|
1228
1224
|
value_formatter?: string;
|
|
1229
1225
|
preview_value_formatter?: string;
|
|
1230
1226
|
/**
|
|
@@ -1354,11 +1350,9 @@ declare namespace Components {
|
|
|
1354
1350
|
*/
|
|
1355
1351
|
feature_flag?: string;
|
|
1356
1352
|
/**
|
|
1357
|
-
* This attribute should only be active when the
|
|
1358
|
-
* example:
|
|
1359
|
-
* MY_SETTING
|
|
1353
|
+
* This attribute should only be active when all the settings have the correct value
|
|
1360
1354
|
*/
|
|
1361
|
-
|
|
1355
|
+
settings_flag?: SettingFlag[];
|
|
1362
1356
|
value_formatter?: string;
|
|
1363
1357
|
preview_value_formatter?: string;
|
|
1364
1358
|
/**
|
|
@@ -1403,16 +1397,6 @@ declare namespace Components {
|
|
|
1403
1397
|
};
|
|
1404
1398
|
type?: "date" | "datetime";
|
|
1405
1399
|
}
|
|
1406
|
-
export interface ESClusterAssignment {
|
|
1407
|
-
/**
|
|
1408
|
-
* The organization for which the cluster assignment is returned
|
|
1409
|
-
*/
|
|
1410
|
-
orgId?: string;
|
|
1411
|
-
/**
|
|
1412
|
-
* Name of the elastic cluster the organization is assigned to
|
|
1413
|
-
*/
|
|
1414
|
-
cluster?: string;
|
|
1415
|
-
}
|
|
1416
1400
|
/**
|
|
1417
1401
|
* example:
|
|
1418
1402
|
* {
|
|
@@ -1613,11 +1597,9 @@ declare namespace Components {
|
|
|
1613
1597
|
*/
|
|
1614
1598
|
feature_flag?: string;
|
|
1615
1599
|
/**
|
|
1616
|
-
* This capability should only be active when the
|
|
1617
|
-
* example:
|
|
1618
|
-
* MY_SETTING
|
|
1600
|
+
* This capability should only be active when all the settings have the correct value
|
|
1619
1601
|
*/
|
|
1620
|
-
|
|
1602
|
+
settings_flag?: SettingFlag[];
|
|
1621
1603
|
}
|
|
1622
1604
|
export interface EntityDefaultCreate {
|
|
1623
1605
|
view_type?: "default";
|
|
@@ -2150,11 +2132,9 @@ declare namespace Components {
|
|
|
2150
2132
|
*/
|
|
2151
2133
|
feature_flag?: string;
|
|
2152
2134
|
/**
|
|
2153
|
-
* This group should only be active when the
|
|
2154
|
-
* example:
|
|
2155
|
-
* MY_SETTING
|
|
2135
|
+
* This group should only be active when all the settings have the correct value
|
|
2156
2136
|
*/
|
|
2157
|
-
|
|
2137
|
+
settings_flag?: SettingFlag[];
|
|
2158
2138
|
info_tooltip_title?: {
|
|
2159
2139
|
key?: string;
|
|
2160
2140
|
default?: string;
|
|
@@ -2407,11 +2387,9 @@ declare namespace Components {
|
|
|
2407
2387
|
*/
|
|
2408
2388
|
feature_flag?: string;
|
|
2409
2389
|
/**
|
|
2410
|
-
* This group should only be active when the
|
|
2411
|
-
* example:
|
|
2412
|
-
* MY_SETTING
|
|
2390
|
+
* This group should only be active when all the settings have the correct value
|
|
2413
2391
|
*/
|
|
2414
|
-
|
|
2392
|
+
settings_flag?: SettingFlag[];
|
|
2415
2393
|
info_tooltip_title?: {
|
|
2416
2394
|
key?: string;
|
|
2417
2395
|
default?: string;
|
|
@@ -2635,6 +2613,60 @@ declare namespace Components {
|
|
|
2635
2613
|
* contact
|
|
2636
2614
|
*/
|
|
2637
2615
|
export type EntitySlug = string;
|
|
2616
|
+
/**
|
|
2617
|
+
* Validation error for an entity attribute
|
|
2618
|
+
*/
|
|
2619
|
+
export interface EntityValidationError {
|
|
2620
|
+
/**
|
|
2621
|
+
* Error code identifier
|
|
2622
|
+
* example:
|
|
2623
|
+
* custom
|
|
2624
|
+
*/
|
|
2625
|
+
code: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* Additional parameters for the error
|
|
2628
|
+
*/
|
|
2629
|
+
params: {
|
|
2630
|
+
/**
|
|
2631
|
+
* The type of the error
|
|
2632
|
+
* example:
|
|
2633
|
+
* missing_field
|
|
2634
|
+
*/
|
|
2635
|
+
type?: string;
|
|
2636
|
+
};
|
|
2637
|
+
/**
|
|
2638
|
+
* The path to the attribute that failed validation
|
|
2639
|
+
* example:
|
|
2640
|
+
* [
|
|
2641
|
+
* "first_name"
|
|
2642
|
+
* ]
|
|
2643
|
+
*/
|
|
2644
|
+
path: string[];
|
|
2645
|
+
/**
|
|
2646
|
+
* A human-readable message describing the error
|
|
2647
|
+
* example:
|
|
2648
|
+
* Invalid input
|
|
2649
|
+
*/
|
|
2650
|
+
message: string;
|
|
2651
|
+
}
|
|
2652
|
+
/**
|
|
2653
|
+
* Validation result for a failed validation
|
|
2654
|
+
*/
|
|
2655
|
+
export interface EntityValidationResultError {
|
|
2656
|
+
status: "error";
|
|
2657
|
+
errors: [
|
|
2658
|
+
/* Validation error for an entity attribute */ EntityValidationError,
|
|
2659
|
+
.../* Validation error for an entity attribute */ EntityValidationError[]
|
|
2660
|
+
];
|
|
2661
|
+
}
|
|
2662
|
+
/**
|
|
2663
|
+
* Validation result for a successful validation
|
|
2664
|
+
*/
|
|
2665
|
+
export interface EntityValidationResultSuccess {
|
|
2666
|
+
status: "success";
|
|
2667
|
+
errors: [
|
|
2668
|
+
];
|
|
2669
|
+
}
|
|
2638
2670
|
export interface EntityViewDisabled {
|
|
2639
2671
|
view_type?: "disabled";
|
|
2640
2672
|
}
|
|
@@ -2737,11 +2769,9 @@ declare namespace Components {
|
|
|
2737
2769
|
*/
|
|
2738
2770
|
feature_flag?: string;
|
|
2739
2771
|
/**
|
|
2740
|
-
* This attribute should only be active when the
|
|
2741
|
-
* example:
|
|
2742
|
-
* MY_SETTING
|
|
2772
|
+
* This attribute should only be active when all the settings have the correct value
|
|
2743
2773
|
*/
|
|
2744
|
-
|
|
2774
|
+
settings_flag?: SettingFlag[];
|
|
2745
2775
|
value_formatter?: string;
|
|
2746
2776
|
preview_value_formatter?: string;
|
|
2747
2777
|
/**
|
|
@@ -2917,6 +2947,126 @@ declare namespace Components {
|
|
|
2917
2947
|
entity_id: EntityId /* uuid */;
|
|
2918
2948
|
}[];
|
|
2919
2949
|
}
|
|
2950
|
+
/**
|
|
2951
|
+
* Entity with relation data resolved into the attribute values
|
|
2952
|
+
* example:
|
|
2953
|
+
* {
|
|
2954
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
2955
|
+
* "_org": "123",
|
|
2956
|
+
* "_owners": [
|
|
2957
|
+
* {
|
|
2958
|
+
* "org_id": "123",
|
|
2959
|
+
* "user_id": "123"
|
|
2960
|
+
* }
|
|
2961
|
+
* ],
|
|
2962
|
+
* "_schema": "contact",
|
|
2963
|
+
* "_tags": [
|
|
2964
|
+
* "example",
|
|
2965
|
+
* "mock"
|
|
2966
|
+
* ],
|
|
2967
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
2968
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
2969
|
+
* "_acl": {
|
|
2970
|
+
* "view": [
|
|
2971
|
+
* "org:456",
|
|
2972
|
+
* "org:789"
|
|
2973
|
+
* ],
|
|
2974
|
+
* "edit": [
|
|
2975
|
+
* "org:456"
|
|
2976
|
+
* ],
|
|
2977
|
+
* "delete": [
|
|
2978
|
+
* "org:456"
|
|
2979
|
+
* ]
|
|
2980
|
+
* },
|
|
2981
|
+
* "_relations": [
|
|
2982
|
+
* {
|
|
2983
|
+
* "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
2984
|
+
* }
|
|
2985
|
+
* ],
|
|
2986
|
+
* "status": "active",
|
|
2987
|
+
* "customer_number": "abc123",
|
|
2988
|
+
* "email": [
|
|
2989
|
+
* {
|
|
2990
|
+
* "label": "work",
|
|
2991
|
+
* "email": "user@example.com"
|
|
2992
|
+
* }
|
|
2993
|
+
* ],
|
|
2994
|
+
* "phone": [
|
|
2995
|
+
* {
|
|
2996
|
+
* "label": "work",
|
|
2997
|
+
* "phone": "+49123456789"
|
|
2998
|
+
* }
|
|
2999
|
+
* ],
|
|
3000
|
+
* "first_name": "First Name",
|
|
3001
|
+
* "middle_name": "Middle Name",
|
|
3002
|
+
* "last_name": "Last Name",
|
|
3003
|
+
* "date_of_birth": "2019-08-24",
|
|
3004
|
+
* "title": "Mr.",
|
|
3005
|
+
* "account": [
|
|
3006
|
+
* {
|
|
3007
|
+
* "status": "active",
|
|
3008
|
+
* "name": "Company name",
|
|
3009
|
+
* "company_email": [
|
|
3010
|
+
* {
|
|
3011
|
+
* "label": "Company email",
|
|
3012
|
+
* "email": "company@example.com"
|
|
3013
|
+
* }
|
|
3014
|
+
* ],
|
|
3015
|
+
* "company_phone": [
|
|
3016
|
+
* {
|
|
3017
|
+
* "label": "Support phone",
|
|
3018
|
+
* "phone": "+49123456789"
|
|
3019
|
+
* }
|
|
3020
|
+
* ],
|
|
3021
|
+
* "company_website": "https://example.com",
|
|
3022
|
+
* "tax_id": "DE123456789",
|
|
3023
|
+
* "tax_exemption": "2019-08-24",
|
|
3024
|
+
* "contacts": {
|
|
3025
|
+
* "$relation": [
|
|
3026
|
+
* {
|
|
3027
|
+
* "_tags": [
|
|
3028
|
+
* "CEO"
|
|
3029
|
+
* ],
|
|
3030
|
+
* "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
3031
|
+
* }
|
|
3032
|
+
* ]
|
|
3033
|
+
* }
|
|
3034
|
+
* }
|
|
3035
|
+
* ]
|
|
3036
|
+
* }
|
|
3037
|
+
*/
|
|
3038
|
+
export interface HydratedEntityItem {
|
|
3039
|
+
[name: string]: any;
|
|
3040
|
+
_id: EntityId /* uuid */;
|
|
3041
|
+
/**
|
|
3042
|
+
* Organization Id the entity belongs to
|
|
3043
|
+
*/
|
|
3044
|
+
_org: string;
|
|
3045
|
+
_owners?: /**
|
|
3046
|
+
* The user / organization owning this entity.
|
|
3047
|
+
*
|
|
3048
|
+
* Note: Owner implicitly has access to the entity regardless of ACLs.
|
|
3049
|
+
*
|
|
3050
|
+
*/
|
|
3051
|
+
EntityOwner[];
|
|
3052
|
+
_schema: /**
|
|
3053
|
+
* URL-friendly identifier for the entity schema
|
|
3054
|
+
* example:
|
|
3055
|
+
* contact
|
|
3056
|
+
*/
|
|
3057
|
+
EntitySlug;
|
|
3058
|
+
/**
|
|
3059
|
+
* Title of entity
|
|
3060
|
+
*/
|
|
3061
|
+
_title: string | null;
|
|
3062
|
+
_tags?: string[] | null;
|
|
3063
|
+
_created_at: string | null; // date-time
|
|
3064
|
+
_updated_at: string | null; // date-time
|
|
3065
|
+
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
|
|
3066
|
+
_relations: {
|
|
3067
|
+
entity_id: EntityId /* uuid */;
|
|
3068
|
+
}[];
|
|
3069
|
+
}
|
|
2920
3070
|
/**
|
|
2921
3071
|
* No UI representation
|
|
2922
3072
|
*/
|
|
@@ -2992,11 +3142,9 @@ declare namespace Components {
|
|
|
2992
3142
|
*/
|
|
2993
3143
|
feature_flag?: string;
|
|
2994
3144
|
/**
|
|
2995
|
-
* This attribute should only be active when the
|
|
2996
|
-
* example:
|
|
2997
|
-
* MY_SETTING
|
|
3145
|
+
* This attribute should only be active when all the settings have the correct value
|
|
2998
3146
|
*/
|
|
2999
|
-
|
|
3147
|
+
settings_flag?: SettingFlag[];
|
|
3000
3148
|
value_formatter?: string;
|
|
3001
3149
|
preview_value_formatter?: string;
|
|
3002
3150
|
/**
|
|
@@ -3116,11 +3264,9 @@ declare namespace Components {
|
|
|
3116
3264
|
*/
|
|
3117
3265
|
feature_flag?: string;
|
|
3118
3266
|
/**
|
|
3119
|
-
* This attribute should only be active when the
|
|
3120
|
-
* example:
|
|
3121
|
-
* MY_SETTING
|
|
3267
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3122
3268
|
*/
|
|
3123
|
-
|
|
3269
|
+
settings_flag?: SettingFlag[];
|
|
3124
3270
|
value_formatter?: string;
|
|
3125
3271
|
preview_value_formatter?: string;
|
|
3126
3272
|
/**
|
|
@@ -3240,11 +3386,9 @@ declare namespace Components {
|
|
|
3240
3386
|
*/
|
|
3241
3387
|
feature_flag?: string;
|
|
3242
3388
|
/**
|
|
3243
|
-
* This attribute should only be active when the
|
|
3244
|
-
* example:
|
|
3245
|
-
* MY_SETTING
|
|
3389
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3246
3390
|
*/
|
|
3247
|
-
|
|
3391
|
+
settings_flag?: SettingFlag[];
|
|
3248
3392
|
value_formatter?: string;
|
|
3249
3393
|
preview_value_formatter?: string;
|
|
3250
3394
|
/**
|
|
@@ -3372,11 +3516,9 @@ declare namespace Components {
|
|
|
3372
3516
|
*/
|
|
3373
3517
|
feature_flag?: string;
|
|
3374
3518
|
/**
|
|
3375
|
-
* This attribute should only be active when the
|
|
3376
|
-
* example:
|
|
3377
|
-
* MY_SETTING
|
|
3519
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3378
3520
|
*/
|
|
3379
|
-
|
|
3521
|
+
settings_flag?: SettingFlag[];
|
|
3380
3522
|
value_formatter?: string;
|
|
3381
3523
|
preview_value_formatter?: string;
|
|
3382
3524
|
/**
|
|
@@ -3496,11 +3638,9 @@ declare namespace Components {
|
|
|
3496
3638
|
*/
|
|
3497
3639
|
feature_flag?: string;
|
|
3498
3640
|
/**
|
|
3499
|
-
* This attribute should only be active when the
|
|
3500
|
-
* example:
|
|
3501
|
-
* MY_SETTING
|
|
3641
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3502
3642
|
*/
|
|
3503
|
-
|
|
3643
|
+
settings_flag?: SettingFlag[];
|
|
3504
3644
|
value_formatter?: string;
|
|
3505
3645
|
preview_value_formatter?: string;
|
|
3506
3646
|
/**
|
|
@@ -3636,11 +3776,9 @@ declare namespace Components {
|
|
|
3636
3776
|
*/
|
|
3637
3777
|
feature_flag?: string;
|
|
3638
3778
|
/**
|
|
3639
|
-
* This attribute should only be active when the
|
|
3640
|
-
* example:
|
|
3641
|
-
* MY_SETTING
|
|
3779
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3642
3780
|
*/
|
|
3643
|
-
|
|
3781
|
+
settings_flag?: SettingFlag[];
|
|
3644
3782
|
value_formatter?: string;
|
|
3645
3783
|
preview_value_formatter?: string;
|
|
3646
3784
|
/**
|
|
@@ -3761,11 +3899,9 @@ declare namespace Components {
|
|
|
3761
3899
|
*/
|
|
3762
3900
|
feature_flag?: string;
|
|
3763
3901
|
/**
|
|
3764
|
-
* This attribute should only be active when the
|
|
3765
|
-
* example:
|
|
3766
|
-
* MY_SETTING
|
|
3902
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3767
3903
|
*/
|
|
3768
|
-
|
|
3904
|
+
settings_flag?: SettingFlag[];
|
|
3769
3905
|
value_formatter?: string;
|
|
3770
3906
|
preview_value_formatter?: string;
|
|
3771
3907
|
/**
|
|
@@ -3885,11 +4021,9 @@ declare namespace Components {
|
|
|
3885
4021
|
*/
|
|
3886
4022
|
feature_flag?: string;
|
|
3887
4023
|
/**
|
|
3888
|
-
* This attribute should only be active when the
|
|
3889
|
-
* example:
|
|
3890
|
-
* MY_SETTING
|
|
4024
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3891
4025
|
*/
|
|
3892
|
-
|
|
4026
|
+
settings_flag?: SettingFlag[];
|
|
3893
4027
|
value_formatter?: string;
|
|
3894
4028
|
preview_value_formatter?: string;
|
|
3895
4029
|
/**
|
|
@@ -4009,11 +4143,9 @@ declare namespace Components {
|
|
|
4009
4143
|
*/
|
|
4010
4144
|
feature_flag?: string;
|
|
4011
4145
|
/**
|
|
4012
|
-
* This attribute should only be active when the
|
|
4013
|
-
* example:
|
|
4014
|
-
* MY_SETTING
|
|
4146
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4015
4147
|
*/
|
|
4016
|
-
|
|
4148
|
+
settings_flag?: SettingFlag[];
|
|
4017
4149
|
value_formatter?: string;
|
|
4018
4150
|
preview_value_formatter?: string;
|
|
4019
4151
|
/**
|
|
@@ -4133,11 +4265,9 @@ declare namespace Components {
|
|
|
4133
4265
|
*/
|
|
4134
4266
|
feature_flag?: string;
|
|
4135
4267
|
/**
|
|
4136
|
-
* This attribute should only be active when the
|
|
4137
|
-
* example:
|
|
4138
|
-
* MY_SETTING
|
|
4268
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4139
4269
|
*/
|
|
4140
|
-
|
|
4270
|
+
settings_flag?: SettingFlag[];
|
|
4141
4271
|
value_formatter?: string;
|
|
4142
4272
|
preview_value_formatter?: string;
|
|
4143
4273
|
/**
|
|
@@ -4262,11 +4392,9 @@ declare namespace Components {
|
|
|
4262
4392
|
*/
|
|
4263
4393
|
feature_flag?: string;
|
|
4264
4394
|
/**
|
|
4265
|
-
* This attribute should only be active when the
|
|
4266
|
-
* example:
|
|
4267
|
-
* MY_SETTING
|
|
4395
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4268
4396
|
*/
|
|
4269
|
-
|
|
4397
|
+
settings_flag?: SettingFlag[];
|
|
4270
4398
|
value_formatter?: string;
|
|
4271
4399
|
preview_value_formatter?: string;
|
|
4272
4400
|
/**
|
|
@@ -4405,11 +4533,9 @@ declare namespace Components {
|
|
|
4405
4533
|
*/
|
|
4406
4534
|
feature_flag?: string;
|
|
4407
4535
|
/**
|
|
4408
|
-
* This attribute should only be active when the
|
|
4409
|
-
* example:
|
|
4410
|
-
* MY_SETTING
|
|
4536
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4411
4537
|
*/
|
|
4412
|
-
|
|
4538
|
+
settings_flag?: SettingFlag[];
|
|
4413
4539
|
value_formatter?: string;
|
|
4414
4540
|
preview_value_formatter?: string;
|
|
4415
4541
|
/**
|
|
@@ -4523,9 +4649,9 @@ declare namespace Components {
|
|
|
4523
4649
|
*/
|
|
4524
4650
|
feature_flag?: string;
|
|
4525
4651
|
/**
|
|
4526
|
-
*
|
|
4652
|
+
* This action should only be active when all the settings have the correct value
|
|
4527
4653
|
*/
|
|
4528
|
-
|
|
4654
|
+
settings_flag?: SettingFlag[];
|
|
4529
4655
|
/**
|
|
4530
4656
|
* example:
|
|
4531
4657
|
* {
|
|
@@ -4766,11 +4892,9 @@ declare namespace Components {
|
|
|
4766
4892
|
*/
|
|
4767
4893
|
feature_flag?: string;
|
|
4768
4894
|
/**
|
|
4769
|
-
* This attribute should only be active when the
|
|
4770
|
-
* example:
|
|
4771
|
-
* MY_SETTING
|
|
4895
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4772
4896
|
*/
|
|
4773
|
-
|
|
4897
|
+
settings_flag?: SettingFlag[];
|
|
4774
4898
|
value_formatter?: string;
|
|
4775
4899
|
preview_value_formatter?: string;
|
|
4776
4900
|
/**
|
|
@@ -5063,11 +5187,9 @@ declare namespace Components {
|
|
|
5063
5187
|
*/
|
|
5064
5188
|
feature_flag?: string;
|
|
5065
5189
|
/**
|
|
5066
|
-
* This attribute should only be active when the
|
|
5067
|
-
* example:
|
|
5068
|
-
* MY_SETTING
|
|
5190
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5069
5191
|
*/
|
|
5070
|
-
|
|
5192
|
+
settings_flag?: SettingFlag[];
|
|
5071
5193
|
value_formatter?: string;
|
|
5072
5194
|
preview_value_formatter?: string;
|
|
5073
5195
|
/**
|
|
@@ -5195,11 +5317,9 @@ declare namespace Components {
|
|
|
5195
5317
|
*/
|
|
5196
5318
|
feature_flag?: string;
|
|
5197
5319
|
/**
|
|
5198
|
-
* This attribute should only be active when the
|
|
5199
|
-
* example:
|
|
5200
|
-
* MY_SETTING
|
|
5320
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5201
5321
|
*/
|
|
5202
|
-
|
|
5322
|
+
settings_flag?: SettingFlag[];
|
|
5203
5323
|
value_formatter?: string;
|
|
5204
5324
|
preview_value_formatter?: string;
|
|
5205
5325
|
/**
|
|
@@ -5251,6 +5371,16 @@ declare namespace Components {
|
|
|
5251
5371
|
prefix?: string;
|
|
5252
5372
|
start_number?: number;
|
|
5253
5373
|
}
|
|
5374
|
+
export interface SettingFlag {
|
|
5375
|
+
/**
|
|
5376
|
+
* The name of the organization setting to check
|
|
5377
|
+
*/
|
|
5378
|
+
name?: string;
|
|
5379
|
+
/**
|
|
5380
|
+
* Whether the setting should be enabled or not
|
|
5381
|
+
*/
|
|
5382
|
+
enabled?: boolean;
|
|
5383
|
+
}
|
|
5254
5384
|
/**
|
|
5255
5385
|
* Status select
|
|
5256
5386
|
*/
|
|
@@ -5326,11 +5456,9 @@ declare namespace Components {
|
|
|
5326
5456
|
*/
|
|
5327
5457
|
feature_flag?: string;
|
|
5328
5458
|
/**
|
|
5329
|
-
* This attribute should only be active when the
|
|
5330
|
-
* example:
|
|
5331
|
-
* MY_SETTING
|
|
5459
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5332
5460
|
*/
|
|
5333
|
-
|
|
5461
|
+
settings_flag?: SettingFlag[];
|
|
5334
5462
|
value_formatter?: string;
|
|
5335
5463
|
preview_value_formatter?: string;
|
|
5336
5464
|
/**
|
|
@@ -5428,9 +5556,9 @@ declare namespace Components {
|
|
|
5428
5556
|
*/
|
|
5429
5557
|
feature_flag?: string;
|
|
5430
5558
|
/**
|
|
5431
|
-
*
|
|
5559
|
+
* This summary attribute should only be visible when all the settings have the correct value
|
|
5432
5560
|
*/
|
|
5433
|
-
|
|
5561
|
+
settings_flag?: SettingFlag[];
|
|
5434
5562
|
}
|
|
5435
5563
|
/**
|
|
5436
5564
|
* Summary Fields are displayed inside list view as a resume of the relation entity.
|
|
@@ -5520,11 +5648,9 @@ declare namespace Components {
|
|
|
5520
5648
|
*/
|
|
5521
5649
|
feature_flag?: string;
|
|
5522
5650
|
/**
|
|
5523
|
-
* This attribute should only be active when the
|
|
5524
|
-
* example:
|
|
5525
|
-
* MY_SETTING
|
|
5651
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5526
5652
|
*/
|
|
5527
|
-
|
|
5653
|
+
settings_flag?: SettingFlag[];
|
|
5528
5654
|
value_formatter?: string;
|
|
5529
5655
|
preview_value_formatter?: string;
|
|
5530
5656
|
/**
|
|
@@ -5685,11 +5811,9 @@ declare namespace Components {
|
|
|
5685
5811
|
*/
|
|
5686
5812
|
feature_flag?: string;
|
|
5687
5813
|
/**
|
|
5688
|
-
* This attribute should only be active when the
|
|
5689
|
-
* example:
|
|
5690
|
-
* MY_SETTING
|
|
5814
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5691
5815
|
*/
|
|
5692
|
-
|
|
5816
|
+
settings_flag?: SettingFlag[];
|
|
5693
5817
|
value_formatter?: string;
|
|
5694
5818
|
preview_value_formatter?: string;
|
|
5695
5819
|
/**
|
|
@@ -5810,11 +5934,9 @@ declare namespace Components {
|
|
|
5810
5934
|
*/
|
|
5811
5935
|
feature_flag?: string;
|
|
5812
5936
|
/**
|
|
5813
|
-
* This attribute should only be active when the
|
|
5814
|
-
* example:
|
|
5815
|
-
* MY_SETTING
|
|
5937
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5816
5938
|
*/
|
|
5817
|
-
|
|
5939
|
+
settings_flag?: SettingFlag[];
|
|
5818
5940
|
value_formatter?: string;
|
|
5819
5941
|
preview_value_formatter?: string;
|
|
5820
5942
|
/**
|
|
@@ -6213,17 +6335,6 @@ declare namespace Paths {
|
|
|
6213
6335
|
export type $200 = Components.Schemas.ActivityItem;
|
|
6214
6336
|
}
|
|
6215
6337
|
}
|
|
6216
|
-
namespace GetElasticClusterForOrg {
|
|
6217
|
-
namespace Parameters {
|
|
6218
|
-
export type OrgId = string;
|
|
6219
|
-
}
|
|
6220
|
-
export interface PathParameters {
|
|
6221
|
-
orgId: Parameters.OrgId;
|
|
6222
|
-
}
|
|
6223
|
-
namespace Responses {
|
|
6224
|
-
export type $200 = Components.Schemas.ESClusterAssignment;
|
|
6225
|
-
}
|
|
6226
|
-
}
|
|
6227
6338
|
namespace GetEntity {
|
|
6228
6339
|
namespace Parameters {
|
|
6229
6340
|
export type Hydrate = boolean;
|
|
@@ -6662,6 +6773,15 @@ declare namespace Paths {
|
|
|
6662
6773
|
namespace Parameters {
|
|
6663
6774
|
export type DraftsFrom = number;
|
|
6664
6775
|
export type DraftsSize = number;
|
|
6776
|
+
/**
|
|
6777
|
+
* example:
|
|
6778
|
+
* [
|
|
6779
|
+
* "id",
|
|
6780
|
+
* "attributes",
|
|
6781
|
+
* "capabilites"
|
|
6782
|
+
* ]
|
|
6783
|
+
*/
|
|
6784
|
+
export type Fields = string[];
|
|
6665
6785
|
export type Slug = /**
|
|
6666
6786
|
* URL-friendly identifier for the entity schema
|
|
6667
6787
|
* example:
|
|
@@ -6679,6 +6799,15 @@ declare namespace Paths {
|
|
|
6679
6799
|
versions_size?: Parameters.VersionsSize;
|
|
6680
6800
|
drafts_from?: Parameters.DraftsFrom;
|
|
6681
6801
|
drafts_size?: Parameters.DraftsSize;
|
|
6802
|
+
fields?: /**
|
|
6803
|
+
* example:
|
|
6804
|
+
* [
|
|
6805
|
+
* "id",
|
|
6806
|
+
* "attributes",
|
|
6807
|
+
* "capabilites"
|
|
6808
|
+
* ]
|
|
6809
|
+
*/
|
|
6810
|
+
Parameters.Fields;
|
|
6682
6811
|
}
|
|
6683
6812
|
namespace Responses {
|
|
6684
6813
|
export interface $200 {
|
|
@@ -7292,6 +7421,61 @@ declare namespace Paths {
|
|
|
7292
7421
|
}
|
|
7293
7422
|
}
|
|
7294
7423
|
}
|
|
7424
|
+
namespace ValidateEntity {
|
|
7425
|
+
namespace Parameters {
|
|
7426
|
+
/**
|
|
7427
|
+
* URL-friendly identifier for the entity schema
|
|
7428
|
+
* example:
|
|
7429
|
+
* price
|
|
7430
|
+
*/
|
|
7431
|
+
export type Slug = string;
|
|
7432
|
+
}
|
|
7433
|
+
export interface PathParameters {
|
|
7434
|
+
slug: /**
|
|
7435
|
+
* URL-friendly identifier for the entity schema
|
|
7436
|
+
* example:
|
|
7437
|
+
* price
|
|
7438
|
+
*/
|
|
7439
|
+
Parameters.Slug;
|
|
7440
|
+
}
|
|
7441
|
+
export type RequestBody = /**
|
|
7442
|
+
* example:
|
|
7443
|
+
* {
|
|
7444
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
7445
|
+
* "_org": "123",
|
|
7446
|
+
* "_owners": [
|
|
7447
|
+
* {
|
|
7448
|
+
* "org_id": "123",
|
|
7449
|
+
* "user_id": "123"
|
|
7450
|
+
* }
|
|
7451
|
+
* ],
|
|
7452
|
+
* "_schema": "contact",
|
|
7453
|
+
* "_tags": [
|
|
7454
|
+
* "example",
|
|
7455
|
+
* "mock"
|
|
7456
|
+
* ],
|
|
7457
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
7458
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
7459
|
+
* "_acl": {
|
|
7460
|
+
* "view": [
|
|
7461
|
+
* "org:456",
|
|
7462
|
+
* "org:789"
|
|
7463
|
+
* ],
|
|
7464
|
+
* "edit": [
|
|
7465
|
+
* "org:456"
|
|
7466
|
+
* ],
|
|
7467
|
+
* "delete": [
|
|
7468
|
+
* "org:456"
|
|
7469
|
+
* ]
|
|
7470
|
+
* }
|
|
7471
|
+
* }
|
|
7472
|
+
*/
|
|
7473
|
+
Components.Schemas.Entity;
|
|
7474
|
+
namespace Responses {
|
|
7475
|
+
export type $200 = /* Validation result for a successful validation */ Components.Schemas.EntityValidationResultSuccess;
|
|
7476
|
+
export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationResultError;
|
|
7477
|
+
}
|
|
7478
|
+
}
|
|
7295
7479
|
}
|
|
7296
7480
|
|
|
7297
7481
|
export interface OperationMethods {
|
|
@@ -7475,6 +7659,16 @@ export interface OperationMethods {
|
|
|
7475
7659
|
data?: Paths.CreateEntity.RequestBody,
|
|
7476
7660
|
config?: AxiosRequestConfig
|
|
7477
7661
|
): OperationResponse<Paths.CreateEntity.Responses.$201>
|
|
7662
|
+
/**
|
|
7663
|
+
* validateEntity - validateEntity
|
|
7664
|
+
*
|
|
7665
|
+
* Validates an entity against the schema.
|
|
7666
|
+
*/
|
|
7667
|
+
'validateEntity'(
|
|
7668
|
+
parameters?: Parameters<Paths.ValidateEntity.PathParameters> | null,
|
|
7669
|
+
data?: Paths.ValidateEntity.RequestBody,
|
|
7670
|
+
config?: AxiosRequestConfig
|
|
7671
|
+
): OperationResponse<Paths.ValidateEntity.Responses.$200>
|
|
7478
7672
|
/**
|
|
7479
7673
|
* upsertEntity - upsertEntity
|
|
7480
7674
|
*
|
|
@@ -7942,16 +8136,6 @@ export interface OperationMethods {
|
|
|
7942
8136
|
data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
|
|
7943
8137
|
config?: AxiosRequestConfig
|
|
7944
8138
|
): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
|
|
7945
|
-
/**
|
|
7946
|
-
* getElasticClusterForOrg - getElasticClusterForOrg
|
|
7947
|
-
*
|
|
7948
|
-
* Gets the Elastic cluster assignment by orgId.
|
|
7949
|
-
*/
|
|
7950
|
-
'getElasticClusterForOrg'(
|
|
7951
|
-
parameters?: Parameters<Paths.GetElasticClusterForOrg.PathParameters> | null,
|
|
7952
|
-
data?: any,
|
|
7953
|
-
config?: AxiosRequestConfig
|
|
7954
|
-
): OperationResponse<Paths.GetElasticClusterForOrg.Responses.$200>
|
|
7955
8139
|
}
|
|
7956
8140
|
|
|
7957
8141
|
export interface PathsDictionary {
|
|
@@ -8149,6 +8333,18 @@ export interface PathsDictionary {
|
|
|
8149
8333
|
config?: AxiosRequestConfig
|
|
8150
8334
|
): OperationResponse<Paths.CreateEntity.Responses.$201>
|
|
8151
8335
|
}
|
|
8336
|
+
['/v1/entity/{slug}:validate']: {
|
|
8337
|
+
/**
|
|
8338
|
+
* validateEntity - validateEntity
|
|
8339
|
+
*
|
|
8340
|
+
* Validates an entity against the schema.
|
|
8341
|
+
*/
|
|
8342
|
+
'post'(
|
|
8343
|
+
parameters?: Parameters<Paths.ValidateEntity.PathParameters> | null,
|
|
8344
|
+
data?: Paths.ValidateEntity.RequestBody,
|
|
8345
|
+
config?: AxiosRequestConfig
|
|
8346
|
+
): OperationResponse<Paths.ValidateEntity.Responses.$200>
|
|
8347
|
+
}
|
|
8152
8348
|
['/v1/entity/{slug}:upsert']: {
|
|
8153
8349
|
/**
|
|
8154
8350
|
* upsertEntity - upsertEntity
|
|
@@ -8664,18 +8860,6 @@ export interface PathsDictionary {
|
|
|
8664
8860
|
config?: AxiosRequestConfig
|
|
8665
8861
|
): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
|
|
8666
8862
|
}
|
|
8667
|
-
['/v1/clusterAssignment/{orgId}']: {
|
|
8668
|
-
/**
|
|
8669
|
-
* getElasticClusterForOrg - getElasticClusterForOrg
|
|
8670
|
-
*
|
|
8671
|
-
* Gets the Elastic cluster assignment by orgId.
|
|
8672
|
-
*/
|
|
8673
|
-
'get'(
|
|
8674
|
-
parameters?: Parameters<Paths.GetElasticClusterForOrg.PathParameters> | null,
|
|
8675
|
-
data?: any,
|
|
8676
|
-
config?: AxiosRequestConfig
|
|
8677
|
-
): OperationResponse<Paths.GetElasticClusterForOrg.Responses.$200>
|
|
8678
|
-
}
|
|
8679
8863
|
}
|
|
8680
8864
|
|
|
8681
8865
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|