@epilot/entity-client 4.21.0-rc.1 → 4.21.0-rc.3
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 -0
- package/dist/openapi.d.ts +240 -293
- package/dist/openapi.json +264 -81
- package/package.json +3 -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
|
/**
|
|
@@ -1603,15 +1597,9 @@ declare namespace Components {
|
|
|
1603
1597
|
*/
|
|
1604
1598
|
feature_flag?: string;
|
|
1605
1599
|
/**
|
|
1606
|
-
* This capability should only be active when the
|
|
1607
|
-
* example:
|
|
1608
|
-
* MY_SETTING
|
|
1609
|
-
*/
|
|
1610
|
-
setting_flag?: string;
|
|
1611
|
-
/**
|
|
1612
|
-
* Only show capability for legacy tenants (ivy)
|
|
1600
|
+
* This capability should only be active when all the settings have the correct value
|
|
1613
1601
|
*/
|
|
1614
|
-
|
|
1602
|
+
settings_flag?: SettingFlag[];
|
|
1615
1603
|
}
|
|
1616
1604
|
export interface EntityDefaultCreate {
|
|
1617
1605
|
view_type?: "default";
|
|
@@ -1631,44 +1619,8 @@ declare namespace Components {
|
|
|
1631
1619
|
}
|
|
1632
1620
|
export interface EntityDefaultTable {
|
|
1633
1621
|
view_type?: "default";
|
|
1634
|
-
dropdown_items?: ({
|
|
1635
|
-
type?: "entity";
|
|
1636
|
-
entity?: /**
|
|
1637
|
-
* URL-friendly identifier for the entity schema
|
|
1638
|
-
* example:
|
|
1639
|
-
* contact
|
|
1640
|
-
*/
|
|
1641
|
-
EntitySlug;
|
|
1642
|
-
/**
|
|
1643
|
-
* This dropdown item should only be active when the feature flag is enabled
|
|
1644
|
-
* example:
|
|
1645
|
-
* FF_MY_FEATURE_FLAG
|
|
1646
|
-
*/
|
|
1647
|
-
feature_flag?: string;
|
|
1648
|
-
/**
|
|
1649
|
-
* Only show item for legacy tenants (ivy)
|
|
1650
|
-
*/
|
|
1651
|
-
legacy?: boolean;
|
|
1652
|
-
} | {
|
|
1653
|
-
type?: "link";
|
|
1654
|
-
/**
|
|
1655
|
-
* example:
|
|
1656
|
-
* Opportunities
|
|
1657
|
-
*/
|
|
1658
|
-
title?: string;
|
|
1659
|
-
uri?: string; // uri-reference
|
|
1660
|
-
/**
|
|
1661
|
-
* This dropdown item should only be active when the feature flag is enabled
|
|
1662
|
-
* example:
|
|
1663
|
-
* FF_MY_FEATURE_FLAG
|
|
1664
|
-
*/
|
|
1665
|
-
feature_flag?: string;
|
|
1666
|
-
/**
|
|
1667
|
-
* Only show item for legacy tenants (ivy)
|
|
1668
|
-
*/
|
|
1669
|
-
legacy?: boolean;
|
|
1670
|
-
})[];
|
|
1671
1622
|
row_actions?: (string | /* An entity action configured from the entity schema */ EntityAction)[];
|
|
1623
|
+
bulk_actions?: (string | /* An entity action configured from the entity schema */ EntityAction)[];
|
|
1672
1624
|
navbar_actions?: {
|
|
1673
1625
|
type: string;
|
|
1674
1626
|
options?: {
|
|
@@ -2152,11 +2104,9 @@ declare namespace Components {
|
|
|
2152
2104
|
*/
|
|
2153
2105
|
feature_flag?: string;
|
|
2154
2106
|
/**
|
|
2155
|
-
* This group should only be active when the
|
|
2156
|
-
* example:
|
|
2157
|
-
* MY_SETTING
|
|
2107
|
+
* This group should only be active when all the settings have the correct value
|
|
2158
2108
|
*/
|
|
2159
|
-
|
|
2109
|
+
settings_flag?: SettingFlag[];
|
|
2160
2110
|
info_tooltip_title?: {
|
|
2161
2111
|
key?: string;
|
|
2162
2112
|
default?: string;
|
|
@@ -2409,11 +2359,9 @@ declare namespace Components {
|
|
|
2409
2359
|
*/
|
|
2410
2360
|
feature_flag?: string;
|
|
2411
2361
|
/**
|
|
2412
|
-
* This group should only be active when the
|
|
2413
|
-
* example:
|
|
2414
|
-
* MY_SETTING
|
|
2362
|
+
* This group should only be active when all the settings have the correct value
|
|
2415
2363
|
*/
|
|
2416
|
-
|
|
2364
|
+
settings_flag?: SettingFlag[];
|
|
2417
2365
|
info_tooltip_title?: {
|
|
2418
2366
|
key?: string;
|
|
2419
2367
|
default?: string;
|
|
@@ -2637,6 +2585,60 @@ declare namespace Components {
|
|
|
2637
2585
|
* contact
|
|
2638
2586
|
*/
|
|
2639
2587
|
export type EntitySlug = string;
|
|
2588
|
+
/**
|
|
2589
|
+
* Validation error for an entity attribute
|
|
2590
|
+
*/
|
|
2591
|
+
export interface EntityValidationError {
|
|
2592
|
+
/**
|
|
2593
|
+
* Error code identifier
|
|
2594
|
+
* example:
|
|
2595
|
+
* custom
|
|
2596
|
+
*/
|
|
2597
|
+
code: string;
|
|
2598
|
+
/**
|
|
2599
|
+
* Additional parameters for the error
|
|
2600
|
+
*/
|
|
2601
|
+
params: {
|
|
2602
|
+
/**
|
|
2603
|
+
* The type of the error
|
|
2604
|
+
* example:
|
|
2605
|
+
* missing_field
|
|
2606
|
+
*/
|
|
2607
|
+
type?: string;
|
|
2608
|
+
};
|
|
2609
|
+
/**
|
|
2610
|
+
* The path to the attribute that failed validation
|
|
2611
|
+
* example:
|
|
2612
|
+
* [
|
|
2613
|
+
* "first_name"
|
|
2614
|
+
* ]
|
|
2615
|
+
*/
|
|
2616
|
+
path: string[];
|
|
2617
|
+
/**
|
|
2618
|
+
* A human-readable message describing the error
|
|
2619
|
+
* example:
|
|
2620
|
+
* Invalid input
|
|
2621
|
+
*/
|
|
2622
|
+
message: string;
|
|
2623
|
+
}
|
|
2624
|
+
/**
|
|
2625
|
+
* Validation result for a failed validation
|
|
2626
|
+
*/
|
|
2627
|
+
export interface EntityValidationResultError {
|
|
2628
|
+
status: "error";
|
|
2629
|
+
errors: [
|
|
2630
|
+
/* Validation error for an entity attribute */ EntityValidationError,
|
|
2631
|
+
.../* Validation error for an entity attribute */ EntityValidationError[]
|
|
2632
|
+
];
|
|
2633
|
+
}
|
|
2634
|
+
/**
|
|
2635
|
+
* Validation result for a successful validation
|
|
2636
|
+
*/
|
|
2637
|
+
export interface EntityValidationResultSuccess {
|
|
2638
|
+
status: "success";
|
|
2639
|
+
errors: [
|
|
2640
|
+
];
|
|
2641
|
+
}
|
|
2640
2642
|
export interface EntityViewDisabled {
|
|
2641
2643
|
view_type?: "disabled";
|
|
2642
2644
|
}
|
|
@@ -2739,11 +2741,9 @@ declare namespace Components {
|
|
|
2739
2741
|
*/
|
|
2740
2742
|
feature_flag?: string;
|
|
2741
2743
|
/**
|
|
2742
|
-
* This attribute should only be active when the
|
|
2743
|
-
* example:
|
|
2744
|
-
* MY_SETTING
|
|
2744
|
+
* This attribute should only be active when all the settings have the correct value
|
|
2745
2745
|
*/
|
|
2746
|
-
|
|
2746
|
+
settings_flag?: SettingFlag[];
|
|
2747
2747
|
value_formatter?: string;
|
|
2748
2748
|
preview_value_formatter?: string;
|
|
2749
2749
|
/**
|
|
@@ -2919,126 +2919,6 @@ declare namespace Components {
|
|
|
2919
2919
|
entity_id: EntityId /* uuid */;
|
|
2920
2920
|
}[];
|
|
2921
2921
|
}
|
|
2922
|
-
/**
|
|
2923
|
-
* Entity with relation data resolved into the attribute values
|
|
2924
|
-
* example:
|
|
2925
|
-
* {
|
|
2926
|
-
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
2927
|
-
* "_org": "123",
|
|
2928
|
-
* "_owners": [
|
|
2929
|
-
* {
|
|
2930
|
-
* "org_id": "123",
|
|
2931
|
-
* "user_id": "123"
|
|
2932
|
-
* }
|
|
2933
|
-
* ],
|
|
2934
|
-
* "_schema": "contact",
|
|
2935
|
-
* "_tags": [
|
|
2936
|
-
* "example",
|
|
2937
|
-
* "mock"
|
|
2938
|
-
* ],
|
|
2939
|
-
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
2940
|
-
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
2941
|
-
* "_acl": {
|
|
2942
|
-
* "view": [
|
|
2943
|
-
* "org:456",
|
|
2944
|
-
* "org:789"
|
|
2945
|
-
* ],
|
|
2946
|
-
* "edit": [
|
|
2947
|
-
* "org:456"
|
|
2948
|
-
* ],
|
|
2949
|
-
* "delete": [
|
|
2950
|
-
* "org:456"
|
|
2951
|
-
* ]
|
|
2952
|
-
* },
|
|
2953
|
-
* "_relations": [
|
|
2954
|
-
* {
|
|
2955
|
-
* "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
2956
|
-
* }
|
|
2957
|
-
* ],
|
|
2958
|
-
* "status": "active",
|
|
2959
|
-
* "customer_number": "abc123",
|
|
2960
|
-
* "email": [
|
|
2961
|
-
* {
|
|
2962
|
-
* "label": "work",
|
|
2963
|
-
* "email": "user@example.com"
|
|
2964
|
-
* }
|
|
2965
|
-
* ],
|
|
2966
|
-
* "phone": [
|
|
2967
|
-
* {
|
|
2968
|
-
* "label": "work",
|
|
2969
|
-
* "phone": "+49123456789"
|
|
2970
|
-
* }
|
|
2971
|
-
* ],
|
|
2972
|
-
* "first_name": "First Name",
|
|
2973
|
-
* "middle_name": "Middle Name",
|
|
2974
|
-
* "last_name": "Last Name",
|
|
2975
|
-
* "date_of_birth": "2019-08-24",
|
|
2976
|
-
* "title": "Mr.",
|
|
2977
|
-
* "account": [
|
|
2978
|
-
* {
|
|
2979
|
-
* "status": "active",
|
|
2980
|
-
* "name": "Company name",
|
|
2981
|
-
* "company_email": [
|
|
2982
|
-
* {
|
|
2983
|
-
* "label": "Company email",
|
|
2984
|
-
* "email": "company@example.com"
|
|
2985
|
-
* }
|
|
2986
|
-
* ],
|
|
2987
|
-
* "company_phone": [
|
|
2988
|
-
* {
|
|
2989
|
-
* "label": "Support phone",
|
|
2990
|
-
* "phone": "+49123456789"
|
|
2991
|
-
* }
|
|
2992
|
-
* ],
|
|
2993
|
-
* "company_website": "https://example.com",
|
|
2994
|
-
* "tax_id": "DE123456789",
|
|
2995
|
-
* "tax_exemption": "2019-08-24",
|
|
2996
|
-
* "contacts": {
|
|
2997
|
-
* "$relation": [
|
|
2998
|
-
* {
|
|
2999
|
-
* "_tags": [
|
|
3000
|
-
* "CEO"
|
|
3001
|
-
* ],
|
|
3002
|
-
* "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
3003
|
-
* }
|
|
3004
|
-
* ]
|
|
3005
|
-
* }
|
|
3006
|
-
* }
|
|
3007
|
-
* ]
|
|
3008
|
-
* }
|
|
3009
|
-
*/
|
|
3010
|
-
export interface HydratedEntityItem {
|
|
3011
|
-
[name: string]: any;
|
|
3012
|
-
_id: EntityId /* uuid */;
|
|
3013
|
-
/**
|
|
3014
|
-
* Organization Id the entity belongs to
|
|
3015
|
-
*/
|
|
3016
|
-
_org: string;
|
|
3017
|
-
_owners?: /**
|
|
3018
|
-
* The user / organization owning this entity.
|
|
3019
|
-
*
|
|
3020
|
-
* Note: Owner implicitly has access to the entity regardless of ACLs.
|
|
3021
|
-
*
|
|
3022
|
-
*/
|
|
3023
|
-
EntityOwner[];
|
|
3024
|
-
_schema: /**
|
|
3025
|
-
* URL-friendly identifier for the entity schema
|
|
3026
|
-
* example:
|
|
3027
|
-
* contact
|
|
3028
|
-
*/
|
|
3029
|
-
EntitySlug;
|
|
3030
|
-
/**
|
|
3031
|
-
* Title of entity
|
|
3032
|
-
*/
|
|
3033
|
-
_title: string | null;
|
|
3034
|
-
_tags?: string[] | null;
|
|
3035
|
-
_created_at: string | null; // date-time
|
|
3036
|
-
_updated_at: string | null; // date-time
|
|
3037
|
-
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
|
|
3038
|
-
_relations: {
|
|
3039
|
-
entity_id: EntityId /* uuid */;
|
|
3040
|
-
}[];
|
|
3041
|
-
}
|
|
3042
2922
|
/**
|
|
3043
2923
|
* No UI representation
|
|
3044
2924
|
*/
|
|
@@ -3114,11 +2994,9 @@ declare namespace Components {
|
|
|
3114
2994
|
*/
|
|
3115
2995
|
feature_flag?: string;
|
|
3116
2996
|
/**
|
|
3117
|
-
* This attribute should only be active when the
|
|
3118
|
-
* example:
|
|
3119
|
-
* MY_SETTING
|
|
2997
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3120
2998
|
*/
|
|
3121
|
-
|
|
2999
|
+
settings_flag?: SettingFlag[];
|
|
3122
3000
|
value_formatter?: string;
|
|
3123
3001
|
preview_value_formatter?: string;
|
|
3124
3002
|
/**
|
|
@@ -3238,11 +3116,9 @@ declare namespace Components {
|
|
|
3238
3116
|
*/
|
|
3239
3117
|
feature_flag?: string;
|
|
3240
3118
|
/**
|
|
3241
|
-
* This attribute should only be active when the
|
|
3242
|
-
* example:
|
|
3243
|
-
* MY_SETTING
|
|
3119
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3244
3120
|
*/
|
|
3245
|
-
|
|
3121
|
+
settings_flag?: SettingFlag[];
|
|
3246
3122
|
value_formatter?: string;
|
|
3247
3123
|
preview_value_formatter?: string;
|
|
3248
3124
|
/**
|
|
@@ -3362,11 +3238,9 @@ declare namespace Components {
|
|
|
3362
3238
|
*/
|
|
3363
3239
|
feature_flag?: string;
|
|
3364
3240
|
/**
|
|
3365
|
-
* This attribute should only be active when the
|
|
3366
|
-
* example:
|
|
3367
|
-
* MY_SETTING
|
|
3241
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3368
3242
|
*/
|
|
3369
|
-
|
|
3243
|
+
settings_flag?: SettingFlag[];
|
|
3370
3244
|
value_formatter?: string;
|
|
3371
3245
|
preview_value_formatter?: string;
|
|
3372
3246
|
/**
|
|
@@ -3494,11 +3368,9 @@ declare namespace Components {
|
|
|
3494
3368
|
*/
|
|
3495
3369
|
feature_flag?: string;
|
|
3496
3370
|
/**
|
|
3497
|
-
* This attribute should only be active when the
|
|
3498
|
-
* example:
|
|
3499
|
-
* MY_SETTING
|
|
3371
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3500
3372
|
*/
|
|
3501
|
-
|
|
3373
|
+
settings_flag?: SettingFlag[];
|
|
3502
3374
|
value_formatter?: string;
|
|
3503
3375
|
preview_value_formatter?: string;
|
|
3504
3376
|
/**
|
|
@@ -3618,11 +3490,9 @@ declare namespace Components {
|
|
|
3618
3490
|
*/
|
|
3619
3491
|
feature_flag?: string;
|
|
3620
3492
|
/**
|
|
3621
|
-
* This attribute should only be active when the
|
|
3622
|
-
* example:
|
|
3623
|
-
* MY_SETTING
|
|
3493
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3624
3494
|
*/
|
|
3625
|
-
|
|
3495
|
+
settings_flag?: SettingFlag[];
|
|
3626
3496
|
value_formatter?: string;
|
|
3627
3497
|
preview_value_formatter?: string;
|
|
3628
3498
|
/**
|
|
@@ -3758,11 +3628,9 @@ declare namespace Components {
|
|
|
3758
3628
|
*/
|
|
3759
3629
|
feature_flag?: string;
|
|
3760
3630
|
/**
|
|
3761
|
-
* This attribute should only be active when the
|
|
3762
|
-
* example:
|
|
3763
|
-
* MY_SETTING
|
|
3631
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3764
3632
|
*/
|
|
3765
|
-
|
|
3633
|
+
settings_flag?: SettingFlag[];
|
|
3766
3634
|
value_formatter?: string;
|
|
3767
3635
|
preview_value_formatter?: string;
|
|
3768
3636
|
/**
|
|
@@ -3883,11 +3751,9 @@ declare namespace Components {
|
|
|
3883
3751
|
*/
|
|
3884
3752
|
feature_flag?: string;
|
|
3885
3753
|
/**
|
|
3886
|
-
* This attribute should only be active when the
|
|
3887
|
-
* example:
|
|
3888
|
-
* MY_SETTING
|
|
3754
|
+
* This attribute should only be active when all the settings have the correct value
|
|
3889
3755
|
*/
|
|
3890
|
-
|
|
3756
|
+
settings_flag?: SettingFlag[];
|
|
3891
3757
|
value_formatter?: string;
|
|
3892
3758
|
preview_value_formatter?: string;
|
|
3893
3759
|
/**
|
|
@@ -4007,11 +3873,9 @@ declare namespace Components {
|
|
|
4007
3873
|
*/
|
|
4008
3874
|
feature_flag?: string;
|
|
4009
3875
|
/**
|
|
4010
|
-
* This attribute should only be active when the
|
|
4011
|
-
* example:
|
|
4012
|
-
* MY_SETTING
|
|
3876
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4013
3877
|
*/
|
|
4014
|
-
|
|
3878
|
+
settings_flag?: SettingFlag[];
|
|
4015
3879
|
value_formatter?: string;
|
|
4016
3880
|
preview_value_formatter?: string;
|
|
4017
3881
|
/**
|
|
@@ -4131,11 +3995,9 @@ declare namespace Components {
|
|
|
4131
3995
|
*/
|
|
4132
3996
|
feature_flag?: string;
|
|
4133
3997
|
/**
|
|
4134
|
-
* This attribute should only be active when the
|
|
4135
|
-
* example:
|
|
4136
|
-
* MY_SETTING
|
|
3998
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4137
3999
|
*/
|
|
4138
|
-
|
|
4000
|
+
settings_flag?: SettingFlag[];
|
|
4139
4001
|
value_formatter?: string;
|
|
4140
4002
|
preview_value_formatter?: string;
|
|
4141
4003
|
/**
|
|
@@ -4255,11 +4117,9 @@ declare namespace Components {
|
|
|
4255
4117
|
*/
|
|
4256
4118
|
feature_flag?: string;
|
|
4257
4119
|
/**
|
|
4258
|
-
* This attribute should only be active when the
|
|
4259
|
-
* example:
|
|
4260
|
-
* MY_SETTING
|
|
4120
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4261
4121
|
*/
|
|
4262
|
-
|
|
4122
|
+
settings_flag?: SettingFlag[];
|
|
4263
4123
|
value_formatter?: string;
|
|
4264
4124
|
preview_value_formatter?: string;
|
|
4265
4125
|
/**
|
|
@@ -4384,11 +4244,9 @@ declare namespace Components {
|
|
|
4384
4244
|
*/
|
|
4385
4245
|
feature_flag?: string;
|
|
4386
4246
|
/**
|
|
4387
|
-
* This attribute should only be active when the
|
|
4388
|
-
* example:
|
|
4389
|
-
* MY_SETTING
|
|
4247
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4390
4248
|
*/
|
|
4391
|
-
|
|
4249
|
+
settings_flag?: SettingFlag[];
|
|
4392
4250
|
value_formatter?: string;
|
|
4393
4251
|
preview_value_formatter?: string;
|
|
4394
4252
|
/**
|
|
@@ -4527,11 +4385,9 @@ declare namespace Components {
|
|
|
4527
4385
|
*/
|
|
4528
4386
|
feature_flag?: string;
|
|
4529
4387
|
/**
|
|
4530
|
-
* This attribute should only be active when the
|
|
4531
|
-
* example:
|
|
4532
|
-
* MY_SETTING
|
|
4388
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4533
4389
|
*/
|
|
4534
|
-
|
|
4390
|
+
settings_flag?: SettingFlag[];
|
|
4535
4391
|
value_formatter?: string;
|
|
4536
4392
|
preview_value_formatter?: string;
|
|
4537
4393
|
/**
|
|
@@ -4645,9 +4501,9 @@ declare namespace Components {
|
|
|
4645
4501
|
*/
|
|
4646
4502
|
feature_flag?: string;
|
|
4647
4503
|
/**
|
|
4648
|
-
*
|
|
4504
|
+
* This action should only be active when all the settings have the correct value
|
|
4649
4505
|
*/
|
|
4650
|
-
|
|
4506
|
+
settings_flag?: SettingFlag[];
|
|
4651
4507
|
/**
|
|
4652
4508
|
* example:
|
|
4653
4509
|
* {
|
|
@@ -4888,11 +4744,9 @@ declare namespace Components {
|
|
|
4888
4744
|
*/
|
|
4889
4745
|
feature_flag?: string;
|
|
4890
4746
|
/**
|
|
4891
|
-
* This attribute should only be active when the
|
|
4892
|
-
* example:
|
|
4893
|
-
* MY_SETTING
|
|
4747
|
+
* This attribute should only be active when all the settings have the correct value
|
|
4894
4748
|
*/
|
|
4895
|
-
|
|
4749
|
+
settings_flag?: SettingFlag[];
|
|
4896
4750
|
value_formatter?: string;
|
|
4897
4751
|
preview_value_formatter?: string;
|
|
4898
4752
|
/**
|
|
@@ -5185,11 +5039,9 @@ declare namespace Components {
|
|
|
5185
5039
|
*/
|
|
5186
5040
|
feature_flag?: string;
|
|
5187
5041
|
/**
|
|
5188
|
-
* This attribute should only be active when the
|
|
5189
|
-
* example:
|
|
5190
|
-
* MY_SETTING
|
|
5042
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5191
5043
|
*/
|
|
5192
|
-
|
|
5044
|
+
settings_flag?: SettingFlag[];
|
|
5193
5045
|
value_formatter?: string;
|
|
5194
5046
|
preview_value_formatter?: string;
|
|
5195
5047
|
/**
|
|
@@ -5317,11 +5169,9 @@ declare namespace Components {
|
|
|
5317
5169
|
*/
|
|
5318
5170
|
feature_flag?: string;
|
|
5319
5171
|
/**
|
|
5320
|
-
* This attribute should only be active when the
|
|
5321
|
-
* example:
|
|
5322
|
-
* MY_SETTING
|
|
5172
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5323
5173
|
*/
|
|
5324
|
-
|
|
5174
|
+
settings_flag?: SettingFlag[];
|
|
5325
5175
|
value_formatter?: string;
|
|
5326
5176
|
preview_value_formatter?: string;
|
|
5327
5177
|
/**
|
|
@@ -5373,6 +5223,16 @@ declare namespace Components {
|
|
|
5373
5223
|
prefix?: string;
|
|
5374
5224
|
start_number?: number;
|
|
5375
5225
|
}
|
|
5226
|
+
export interface SettingFlag {
|
|
5227
|
+
/**
|
|
5228
|
+
* The name of the organization setting to check
|
|
5229
|
+
*/
|
|
5230
|
+
name?: string;
|
|
5231
|
+
/**
|
|
5232
|
+
* Whether the setting should be enabled or not
|
|
5233
|
+
*/
|
|
5234
|
+
enabled?: boolean;
|
|
5235
|
+
}
|
|
5376
5236
|
/**
|
|
5377
5237
|
* Status select
|
|
5378
5238
|
*/
|
|
@@ -5448,11 +5308,9 @@ declare namespace Components {
|
|
|
5448
5308
|
*/
|
|
5449
5309
|
feature_flag?: string;
|
|
5450
5310
|
/**
|
|
5451
|
-
* This attribute should only be active when the
|
|
5452
|
-
* example:
|
|
5453
|
-
* MY_SETTING
|
|
5311
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5454
5312
|
*/
|
|
5455
|
-
|
|
5313
|
+
settings_flag?: SettingFlag[];
|
|
5456
5314
|
value_formatter?: string;
|
|
5457
5315
|
preview_value_formatter?: string;
|
|
5458
5316
|
/**
|
|
@@ -5550,9 +5408,9 @@ declare namespace Components {
|
|
|
5550
5408
|
*/
|
|
5551
5409
|
feature_flag?: string;
|
|
5552
5410
|
/**
|
|
5553
|
-
*
|
|
5411
|
+
* This summary attribute should only be visible when all the settings have the correct value
|
|
5554
5412
|
*/
|
|
5555
|
-
|
|
5413
|
+
settings_flag?: SettingFlag[];
|
|
5556
5414
|
}
|
|
5557
5415
|
/**
|
|
5558
5416
|
* Summary Fields are displayed inside list view as a resume of the relation entity.
|
|
@@ -5642,11 +5500,9 @@ declare namespace Components {
|
|
|
5642
5500
|
*/
|
|
5643
5501
|
feature_flag?: string;
|
|
5644
5502
|
/**
|
|
5645
|
-
* This attribute should only be active when the
|
|
5646
|
-
* example:
|
|
5647
|
-
* MY_SETTING
|
|
5503
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5648
5504
|
*/
|
|
5649
|
-
|
|
5505
|
+
settings_flag?: SettingFlag[];
|
|
5650
5506
|
value_formatter?: string;
|
|
5651
5507
|
preview_value_formatter?: string;
|
|
5652
5508
|
/**
|
|
@@ -5807,11 +5663,9 @@ declare namespace Components {
|
|
|
5807
5663
|
*/
|
|
5808
5664
|
feature_flag?: string;
|
|
5809
5665
|
/**
|
|
5810
|
-
* This attribute should only be active when the
|
|
5811
|
-
* example:
|
|
5812
|
-
* MY_SETTING
|
|
5666
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5813
5667
|
*/
|
|
5814
|
-
|
|
5668
|
+
settings_flag?: SettingFlag[];
|
|
5815
5669
|
value_formatter?: string;
|
|
5816
5670
|
preview_value_formatter?: string;
|
|
5817
5671
|
/**
|
|
@@ -5932,11 +5786,9 @@ declare namespace Components {
|
|
|
5932
5786
|
*/
|
|
5933
5787
|
feature_flag?: string;
|
|
5934
5788
|
/**
|
|
5935
|
-
* This attribute should only be active when the
|
|
5936
|
-
* example:
|
|
5937
|
-
* MY_SETTING
|
|
5789
|
+
* This attribute should only be active when all the settings have the correct value
|
|
5938
5790
|
*/
|
|
5939
|
-
|
|
5791
|
+
settings_flag?: SettingFlag[];
|
|
5940
5792
|
value_formatter?: string;
|
|
5941
5793
|
preview_value_formatter?: string;
|
|
5942
5794
|
/**
|
|
@@ -6773,6 +6625,15 @@ declare namespace Paths {
|
|
|
6773
6625
|
namespace Parameters {
|
|
6774
6626
|
export type DraftsFrom = number;
|
|
6775
6627
|
export type DraftsSize = number;
|
|
6628
|
+
/**
|
|
6629
|
+
* example:
|
|
6630
|
+
* [
|
|
6631
|
+
* "id",
|
|
6632
|
+
* "attributes",
|
|
6633
|
+
* "capabilites"
|
|
6634
|
+
* ]
|
|
6635
|
+
*/
|
|
6636
|
+
export type Fields = string[];
|
|
6776
6637
|
export type Slug = /**
|
|
6777
6638
|
* URL-friendly identifier for the entity schema
|
|
6778
6639
|
* example:
|
|
@@ -6790,6 +6651,15 @@ declare namespace Paths {
|
|
|
6790
6651
|
versions_size?: Parameters.VersionsSize;
|
|
6791
6652
|
drafts_from?: Parameters.DraftsFrom;
|
|
6792
6653
|
drafts_size?: Parameters.DraftsSize;
|
|
6654
|
+
fields?: /**
|
|
6655
|
+
* example:
|
|
6656
|
+
* [
|
|
6657
|
+
* "id",
|
|
6658
|
+
* "attributes",
|
|
6659
|
+
* "capabilites"
|
|
6660
|
+
* ]
|
|
6661
|
+
*/
|
|
6662
|
+
Parameters.Fields;
|
|
6793
6663
|
}
|
|
6794
6664
|
namespace Responses {
|
|
6795
6665
|
export interface $200 {
|
|
@@ -7403,6 +7273,61 @@ declare namespace Paths {
|
|
|
7403
7273
|
}
|
|
7404
7274
|
}
|
|
7405
7275
|
}
|
|
7276
|
+
namespace ValidateEntity {
|
|
7277
|
+
namespace Parameters {
|
|
7278
|
+
/**
|
|
7279
|
+
* URL-friendly identifier for the entity schema
|
|
7280
|
+
* example:
|
|
7281
|
+
* price
|
|
7282
|
+
*/
|
|
7283
|
+
export type Slug = string;
|
|
7284
|
+
}
|
|
7285
|
+
export interface PathParameters {
|
|
7286
|
+
slug: /**
|
|
7287
|
+
* URL-friendly identifier for the entity schema
|
|
7288
|
+
* example:
|
|
7289
|
+
* price
|
|
7290
|
+
*/
|
|
7291
|
+
Parameters.Slug;
|
|
7292
|
+
}
|
|
7293
|
+
export type RequestBody = /**
|
|
7294
|
+
* example:
|
|
7295
|
+
* {
|
|
7296
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
7297
|
+
* "_org": "123",
|
|
7298
|
+
* "_owners": [
|
|
7299
|
+
* {
|
|
7300
|
+
* "org_id": "123",
|
|
7301
|
+
* "user_id": "123"
|
|
7302
|
+
* }
|
|
7303
|
+
* ],
|
|
7304
|
+
* "_schema": "contact",
|
|
7305
|
+
* "_tags": [
|
|
7306
|
+
* "example",
|
|
7307
|
+
* "mock"
|
|
7308
|
+
* ],
|
|
7309
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
7310
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
7311
|
+
* "_acl": {
|
|
7312
|
+
* "view": [
|
|
7313
|
+
* "org:456",
|
|
7314
|
+
* "org:789"
|
|
7315
|
+
* ],
|
|
7316
|
+
* "edit": [
|
|
7317
|
+
* "org:456"
|
|
7318
|
+
* ],
|
|
7319
|
+
* "delete": [
|
|
7320
|
+
* "org:456"
|
|
7321
|
+
* ]
|
|
7322
|
+
* }
|
|
7323
|
+
* }
|
|
7324
|
+
*/
|
|
7325
|
+
Components.Schemas.Entity;
|
|
7326
|
+
namespace Responses {
|
|
7327
|
+
export type $200 = /* Validation result for a successful validation */ Components.Schemas.EntityValidationResultSuccess;
|
|
7328
|
+
export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationResultError;
|
|
7329
|
+
}
|
|
7330
|
+
}
|
|
7406
7331
|
}
|
|
7407
7332
|
|
|
7408
7333
|
export interface OperationMethods {
|
|
@@ -7586,6 +7511,16 @@ export interface OperationMethods {
|
|
|
7586
7511
|
data?: Paths.CreateEntity.RequestBody,
|
|
7587
7512
|
config?: AxiosRequestConfig
|
|
7588
7513
|
): OperationResponse<Paths.CreateEntity.Responses.$201>
|
|
7514
|
+
/**
|
|
7515
|
+
* validateEntity - validateEntity
|
|
7516
|
+
*
|
|
7517
|
+
* Validates an entity against the schema.
|
|
7518
|
+
*/
|
|
7519
|
+
'validateEntity'(
|
|
7520
|
+
parameters?: Parameters<Paths.ValidateEntity.PathParameters> | null,
|
|
7521
|
+
data?: Paths.ValidateEntity.RequestBody,
|
|
7522
|
+
config?: AxiosRequestConfig
|
|
7523
|
+
): OperationResponse<Paths.ValidateEntity.Responses.$200>
|
|
7589
7524
|
/**
|
|
7590
7525
|
* upsertEntity - upsertEntity
|
|
7591
7526
|
*
|
|
@@ -8250,6 +8185,18 @@ export interface PathsDictionary {
|
|
|
8250
8185
|
config?: AxiosRequestConfig
|
|
8251
8186
|
): OperationResponse<Paths.CreateEntity.Responses.$201>
|
|
8252
8187
|
}
|
|
8188
|
+
['/v1/entity/{slug}:validate']: {
|
|
8189
|
+
/**
|
|
8190
|
+
* validateEntity - validateEntity
|
|
8191
|
+
*
|
|
8192
|
+
* Validates an entity against the schema.
|
|
8193
|
+
*/
|
|
8194
|
+
'post'(
|
|
8195
|
+
parameters?: Parameters<Paths.ValidateEntity.PathParameters> | null,
|
|
8196
|
+
data?: Paths.ValidateEntity.RequestBody,
|
|
8197
|
+
config?: AxiosRequestConfig
|
|
8198
|
+
): OperationResponse<Paths.ValidateEntity.Responses.$200>
|
|
8199
|
+
}
|
|
8253
8200
|
['/v1/entity/{slug}:upsert']: {
|
|
8254
8201
|
/**
|
|
8255
8202
|
* upsertEntity - upsertEntity
|