@epilot/entity-client 4.15.6 → 4.16.0-rc1
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/client.d.ts +0 -0
- package/dist/client.js +0 -0
- package/dist/definition.d.ts +0 -0
- package/dist/definition.js +1 -1
- package/dist/index.d.ts +0 -0
- package/dist/index.js +0 -0
- package/dist/openapi-runtime.json +0 -115
- package/dist/openapi.d.ts +1 -442
- package/dist/openapi.json +0 -318
- package/dist/schema-model.d.ts +0 -0
- package/dist/schema-model.js +0 -0
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -158,10 +158,6 @@ declare namespace Components {
|
|
|
158
158
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
159
159
|
*/
|
|
160
160
|
show_in_table?: boolean;
|
|
161
|
-
/**
|
|
162
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
163
|
-
*/
|
|
164
|
-
sortable?: boolean;
|
|
165
161
|
required?: boolean;
|
|
166
162
|
readonly?: boolean;
|
|
167
163
|
deprecated?: boolean;
|
|
@@ -268,7 +264,7 @@ declare namespace Components {
|
|
|
268
264
|
type?: "relation_address";
|
|
269
265
|
has_primary?: boolean;
|
|
270
266
|
}
|
|
271
|
-
export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute
|
|
267
|
+
export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute;
|
|
272
268
|
/**
|
|
273
269
|
* Automation entity
|
|
274
270
|
*/
|
|
@@ -284,10 +280,6 @@ declare namespace Components {
|
|
|
284
280
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
285
281
|
*/
|
|
286
282
|
show_in_table?: boolean;
|
|
287
|
-
/**
|
|
288
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
289
|
-
*/
|
|
290
|
-
sortable?: boolean;
|
|
291
283
|
required?: boolean;
|
|
292
284
|
readonly?: boolean;
|
|
293
285
|
deprecated?: boolean;
|
|
@@ -405,10 +397,6 @@ declare namespace Components {
|
|
|
405
397
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
406
398
|
*/
|
|
407
399
|
show_in_table?: boolean;
|
|
408
|
-
/**
|
|
409
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
410
|
-
*/
|
|
411
|
-
sortable?: boolean;
|
|
412
400
|
required?: boolean;
|
|
413
401
|
readonly?: boolean;
|
|
414
402
|
deprecated?: boolean;
|
|
@@ -593,10 +581,6 @@ declare namespace Components {
|
|
|
593
581
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
594
582
|
*/
|
|
595
583
|
show_in_table?: boolean;
|
|
596
|
-
/**
|
|
597
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
598
|
-
*/
|
|
599
|
-
sortable?: boolean;
|
|
600
584
|
required?: boolean;
|
|
601
585
|
readonly?: boolean;
|
|
602
586
|
deprecated?: boolean;
|
|
@@ -723,10 +707,6 @@ declare namespace Components {
|
|
|
723
707
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
724
708
|
*/
|
|
725
709
|
show_in_table?: boolean;
|
|
726
|
-
/**
|
|
727
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
728
|
-
*/
|
|
729
|
-
sortable?: boolean;
|
|
730
710
|
required?: boolean;
|
|
731
711
|
readonly?: boolean;
|
|
732
712
|
deprecated?: boolean;
|
|
@@ -847,10 +827,6 @@ declare namespace Components {
|
|
|
847
827
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
848
828
|
*/
|
|
849
829
|
show_in_table?: boolean;
|
|
850
|
-
/**
|
|
851
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
852
|
-
*/
|
|
853
|
-
sortable?: boolean;
|
|
854
830
|
required?: boolean;
|
|
855
831
|
readonly?: boolean;
|
|
856
832
|
deprecated?: boolean;
|
|
@@ -973,10 +949,6 @@ declare namespace Components {
|
|
|
973
949
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
974
950
|
*/
|
|
975
951
|
show_in_table?: boolean;
|
|
976
|
-
/**
|
|
977
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
978
|
-
*/
|
|
979
|
-
sortable?: boolean;
|
|
980
952
|
required?: boolean;
|
|
981
953
|
readonly?: boolean;
|
|
982
954
|
deprecated?: boolean;
|
|
@@ -1097,10 +1069,6 @@ declare namespace Components {
|
|
|
1097
1069
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
1098
1070
|
*/
|
|
1099
1071
|
show_in_table?: boolean;
|
|
1100
|
-
/**
|
|
1101
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
1102
|
-
*/
|
|
1103
|
-
sortable?: boolean;
|
|
1104
1072
|
required?: boolean;
|
|
1105
1073
|
readonly?: boolean;
|
|
1106
1074
|
deprecated?: boolean;
|
|
@@ -1231,10 +1199,6 @@ declare namespace Components {
|
|
|
1231
1199
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
1232
1200
|
*/
|
|
1233
1201
|
show_in_table?: boolean;
|
|
1234
|
-
/**
|
|
1235
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
1236
|
-
*/
|
|
1237
|
-
sortable?: boolean;
|
|
1238
1202
|
required?: boolean;
|
|
1239
1203
|
readonly?: boolean;
|
|
1240
1204
|
deprecated?: boolean;
|
|
@@ -2568,10 +2532,6 @@ declare namespace Components {
|
|
|
2568
2532
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
2569
2533
|
*/
|
|
2570
2534
|
show_in_table?: boolean;
|
|
2571
|
-
/**
|
|
2572
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
2573
|
-
*/
|
|
2574
|
-
sortable?: boolean;
|
|
2575
2535
|
required?: boolean;
|
|
2576
2536
|
readonly?: boolean;
|
|
2577
2537
|
deprecated?: boolean;
|
|
@@ -2693,13 +2653,6 @@ declare namespace Components {
|
|
|
2693
2653
|
enable_description?: boolean;
|
|
2694
2654
|
default_access_control?: "public-read" | "private";
|
|
2695
2655
|
}
|
|
2696
|
-
export interface GetRelatedEntitiesCount {
|
|
2697
|
-
/**
|
|
2698
|
-
* example:
|
|
2699
|
-
* 1
|
|
2700
|
-
*/
|
|
2701
|
-
hits?: number;
|
|
2702
|
-
}
|
|
2703
2656
|
export type GetRelationsResp = (RelationItem | /**
|
|
2704
2657
|
* example:
|
|
2705
2658
|
* {
|
|
@@ -2943,10 +2896,6 @@ declare namespace Components {
|
|
|
2943
2896
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
2944
2897
|
*/
|
|
2945
2898
|
show_in_table?: boolean;
|
|
2946
|
-
/**
|
|
2947
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
2948
|
-
*/
|
|
2949
|
-
sortable?: boolean;
|
|
2950
2899
|
required?: boolean;
|
|
2951
2900
|
readonly?: boolean;
|
|
2952
2901
|
deprecated?: boolean;
|
|
@@ -3067,10 +3016,6 @@ declare namespace Components {
|
|
|
3067
3016
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
3068
3017
|
*/
|
|
3069
3018
|
show_in_table?: boolean;
|
|
3070
|
-
/**
|
|
3071
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
3072
|
-
*/
|
|
3073
|
-
sortable?: boolean;
|
|
3074
3019
|
required?: boolean;
|
|
3075
3020
|
readonly?: boolean;
|
|
3076
3021
|
deprecated?: boolean;
|
|
@@ -3191,10 +3136,6 @@ declare namespace Components {
|
|
|
3191
3136
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
3192
3137
|
*/
|
|
3193
3138
|
show_in_table?: boolean;
|
|
3194
|
-
/**
|
|
3195
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
3196
|
-
*/
|
|
3197
|
-
sortable?: boolean;
|
|
3198
3139
|
required?: boolean;
|
|
3199
3140
|
readonly?: boolean;
|
|
3200
3141
|
deprecated?: boolean;
|
|
@@ -3323,10 +3264,6 @@ declare namespace Components {
|
|
|
3323
3264
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
3324
3265
|
*/
|
|
3325
3266
|
show_in_table?: boolean;
|
|
3326
|
-
/**
|
|
3327
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
3328
|
-
*/
|
|
3329
|
-
sortable?: boolean;
|
|
3330
3267
|
required?: boolean;
|
|
3331
3268
|
readonly?: boolean;
|
|
3332
3269
|
deprecated?: boolean;
|
|
@@ -3447,10 +3384,6 @@ declare namespace Components {
|
|
|
3447
3384
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
3448
3385
|
*/
|
|
3449
3386
|
show_in_table?: boolean;
|
|
3450
|
-
/**
|
|
3451
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
3452
|
-
*/
|
|
3453
|
-
sortable?: boolean;
|
|
3454
3387
|
required?: boolean;
|
|
3455
3388
|
readonly?: boolean;
|
|
3456
3389
|
deprecated?: boolean;
|
|
@@ -3587,10 +3520,6 @@ declare namespace Components {
|
|
|
3587
3520
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
3588
3521
|
*/
|
|
3589
3522
|
show_in_table?: boolean;
|
|
3590
|
-
/**
|
|
3591
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
3592
|
-
*/
|
|
3593
|
-
sortable?: boolean;
|
|
3594
3523
|
required?: boolean;
|
|
3595
3524
|
readonly?: boolean;
|
|
3596
3525
|
deprecated?: boolean;
|
|
@@ -3712,10 +3641,6 @@ declare namespace Components {
|
|
|
3712
3641
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
3713
3642
|
*/
|
|
3714
3643
|
show_in_table?: boolean;
|
|
3715
|
-
/**
|
|
3716
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
3717
|
-
*/
|
|
3718
|
-
sortable?: boolean;
|
|
3719
3644
|
required?: boolean;
|
|
3720
3645
|
readonly?: boolean;
|
|
3721
3646
|
deprecated?: boolean;
|
|
@@ -3821,130 +3746,6 @@ declare namespace Components {
|
|
|
3821
3746
|
};
|
|
3822
3747
|
type?: "ordered_list";
|
|
3823
3748
|
}
|
|
3824
|
-
/**
|
|
3825
|
-
* Shared Partner Organisations
|
|
3826
|
-
*/
|
|
3827
|
-
export interface PartnerOrganisationAttribute {
|
|
3828
|
-
name: string;
|
|
3829
|
-
label: string;
|
|
3830
|
-
placeholder?: string;
|
|
3831
|
-
/**
|
|
3832
|
-
* Do not render attribute in entity views
|
|
3833
|
-
*/
|
|
3834
|
-
hidden?: boolean;
|
|
3835
|
-
/**
|
|
3836
|
-
* Render as a column in table views. When defined, overrides `hidden`
|
|
3837
|
-
*/
|
|
3838
|
-
show_in_table?: boolean;
|
|
3839
|
-
/**
|
|
3840
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
3841
|
-
*/
|
|
3842
|
-
sortable?: boolean;
|
|
3843
|
-
required?: boolean;
|
|
3844
|
-
readonly?: boolean;
|
|
3845
|
-
deprecated?: boolean;
|
|
3846
|
-
default_value?: any;
|
|
3847
|
-
/**
|
|
3848
|
-
* Which group the attribute should appear in. Accepts group ID or group name
|
|
3849
|
-
*/
|
|
3850
|
-
group?: string;
|
|
3851
|
-
/**
|
|
3852
|
-
* Attribute sort order (ascending) in group
|
|
3853
|
-
* example:
|
|
3854
|
-
* 0
|
|
3855
|
-
*/
|
|
3856
|
-
order?: number;
|
|
3857
|
-
/**
|
|
3858
|
-
* example:
|
|
3859
|
-
* full_width
|
|
3860
|
-
*/
|
|
3861
|
-
layout?: string;
|
|
3862
|
-
/**
|
|
3863
|
-
* When set to true, will hide the label of the field.
|
|
3864
|
-
*/
|
|
3865
|
-
hide_label?: boolean;
|
|
3866
|
-
/**
|
|
3867
|
-
* Code name of the icon to used to represent this attribute.
|
|
3868
|
-
* The value must be a valid @epilot/base-elements Icon name
|
|
3869
|
-
*
|
|
3870
|
-
*/
|
|
3871
|
-
icon?: string;
|
|
3872
|
-
/**
|
|
3873
|
-
* Defines the conditional rendering expression for showing this field.
|
|
3874
|
-
* When a valid expression is parsed, their evaluation defines the visibility of this attribute.
|
|
3875
|
-
* Note: Empty or invalid expression have no effect on the field visibility.
|
|
3876
|
-
*
|
|
3877
|
-
*/
|
|
3878
|
-
render_condition?: string;
|
|
3879
|
-
_purpose?: ClassificationId /* uuid */[];
|
|
3880
|
-
/**
|
|
3881
|
-
* A set of constraints applicable to the attribute.
|
|
3882
|
-
* These constraints should and will be enforced by the attribute renderer.
|
|
3883
|
-
*
|
|
3884
|
-
* example:
|
|
3885
|
-
* {
|
|
3886
|
-
* "disablePast": true
|
|
3887
|
-
* }
|
|
3888
|
-
*/
|
|
3889
|
-
constraints?: {
|
|
3890
|
-
[key: string]: any;
|
|
3891
|
-
};
|
|
3892
|
-
/**
|
|
3893
|
-
* This attribute should only be active when the feature flag is enabled
|
|
3894
|
-
* example:
|
|
3895
|
-
* FF_MY_FEATURE_FLAG
|
|
3896
|
-
*/
|
|
3897
|
-
feature_flag?: string;
|
|
3898
|
-
/**
|
|
3899
|
-
* This attribute should only be active when the setting is enabled
|
|
3900
|
-
* example:
|
|
3901
|
-
* MY_SETTING
|
|
3902
|
-
*/
|
|
3903
|
-
setting_flag?: string;
|
|
3904
|
-
value_formatter?: string;
|
|
3905
|
-
preview_value_formatter?: string;
|
|
3906
|
-
/**
|
|
3907
|
-
* Setting to `true` disables editing the attribute on the entity builder UI
|
|
3908
|
-
*/
|
|
3909
|
-
entity_builder_disable_edit?: boolean;
|
|
3910
|
-
/**
|
|
3911
|
-
* Setting to `true` prevents the attribute from being modified / deleted
|
|
3912
|
-
*/
|
|
3913
|
-
protected?: boolean;
|
|
3914
|
-
/**
|
|
3915
|
-
* A set of configurations meant to document and assist the user in filling the attribute.
|
|
3916
|
-
*/
|
|
3917
|
-
info_helpers?: {
|
|
3918
|
-
/**
|
|
3919
|
-
* The text to be displayed in the attribute hint helper.
|
|
3920
|
-
* When specified it overrides the `hint_text_key` configuration.
|
|
3921
|
-
*
|
|
3922
|
-
*/
|
|
3923
|
-
hint_text?: string;
|
|
3924
|
-
/**
|
|
3925
|
-
* The key of the hint text to be displayed in the attribute hint helper.
|
|
3926
|
-
* The key should be a valid i18n key.
|
|
3927
|
-
*
|
|
3928
|
-
*/
|
|
3929
|
-
hint_text_key?: string;
|
|
3930
|
-
/**
|
|
3931
|
-
* The name of the custom component to be used as the hint helper.
|
|
3932
|
-
* The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
|
|
3933
|
-
* When specified it overrides the `hint_text` or `hint_text_key` configuration.
|
|
3934
|
-
*
|
|
3935
|
-
*/
|
|
3936
|
-
hint_custom_component?: string;
|
|
3937
|
-
/**
|
|
3938
|
-
* The placement of the hint tooltip.
|
|
3939
|
-
* The value should be a valid `@mui/core` tooltip placement.
|
|
3940
|
-
*
|
|
3941
|
-
* example:
|
|
3942
|
-
* top
|
|
3943
|
-
*/
|
|
3944
|
-
hint_tooltip_placement?: string;
|
|
3945
|
-
};
|
|
3946
|
-
type?: "partner_organisation";
|
|
3947
|
-
}
|
|
3948
3749
|
/**
|
|
3949
3750
|
* Partner Status
|
|
3950
3751
|
*/
|
|
@@ -3960,10 +3761,6 @@ declare namespace Components {
|
|
|
3960
3761
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
3961
3762
|
*/
|
|
3962
3763
|
show_in_table?: boolean;
|
|
3963
|
-
/**
|
|
3964
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
3965
|
-
*/
|
|
3966
|
-
sortable?: boolean;
|
|
3967
3764
|
required?: boolean;
|
|
3968
3765
|
readonly?: boolean;
|
|
3969
3766
|
deprecated?: boolean;
|
|
@@ -4084,10 +3881,6 @@ declare namespace Components {
|
|
|
4084
3881
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
4085
3882
|
*/
|
|
4086
3883
|
show_in_table?: boolean;
|
|
4087
|
-
/**
|
|
4088
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
4089
|
-
*/
|
|
4090
|
-
sortable?: boolean;
|
|
4091
3884
|
required?: boolean;
|
|
4092
3885
|
readonly?: boolean;
|
|
4093
3886
|
deprecated?: boolean;
|
|
@@ -4213,10 +4006,6 @@ declare namespace Components {
|
|
|
4213
4006
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
4214
4007
|
*/
|
|
4215
4008
|
show_in_table?: boolean;
|
|
4216
|
-
/**
|
|
4217
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
4218
|
-
*/
|
|
4219
|
-
sortable?: boolean;
|
|
4220
4009
|
required?: boolean;
|
|
4221
4010
|
readonly?: boolean;
|
|
4222
4011
|
deprecated?: boolean;
|
|
@@ -4356,10 +4145,6 @@ declare namespace Components {
|
|
|
4356
4145
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
4357
4146
|
*/
|
|
4358
4147
|
show_in_table?: boolean;
|
|
4359
|
-
/**
|
|
4360
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
4361
|
-
*/
|
|
4362
|
-
sortable?: boolean;
|
|
4363
4148
|
required?: boolean;
|
|
4364
4149
|
readonly?: boolean;
|
|
4365
4150
|
deprecated?: boolean;
|
|
@@ -4717,10 +4502,6 @@ declare namespace Components {
|
|
|
4717
4502
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
4718
4503
|
*/
|
|
4719
4504
|
show_in_table?: boolean;
|
|
4720
|
-
/**
|
|
4721
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
4722
|
-
*/
|
|
4723
|
-
sortable?: boolean;
|
|
4724
4505
|
required?: boolean;
|
|
4725
4506
|
readonly?: boolean;
|
|
4726
4507
|
deprecated?: boolean;
|
|
@@ -4867,10 +4648,6 @@ declare namespace Components {
|
|
|
4867
4648
|
* true
|
|
4868
4649
|
*/
|
|
4869
4650
|
shared?: boolean;
|
|
4870
|
-
/**
|
|
4871
|
-
* List of users (IDs) that have favorited the view
|
|
4872
|
-
*/
|
|
4873
|
-
isFavoritedBy?: string[];
|
|
4874
4651
|
created_by: {
|
|
4875
4652
|
/**
|
|
4876
4653
|
* example:
|
|
@@ -4940,10 +4717,6 @@ declare namespace Components {
|
|
|
4940
4717
|
* true
|
|
4941
4718
|
*/
|
|
4942
4719
|
shared?: boolean;
|
|
4943
|
-
/**
|
|
4944
|
-
* List of users (IDs) that have favorited the view
|
|
4945
|
-
*/
|
|
4946
|
-
isFavoritedBy?: string[];
|
|
4947
4720
|
created_by: {
|
|
4948
4721
|
/**
|
|
4949
4722
|
* example:
|
|
@@ -5014,10 +4787,6 @@ declare namespace Components {
|
|
|
5014
4787
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
5015
4788
|
*/
|
|
5016
4789
|
show_in_table?: boolean;
|
|
5017
|
-
/**
|
|
5018
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
5019
|
-
*/
|
|
5020
|
-
sortable?: boolean;
|
|
5021
4790
|
required?: boolean;
|
|
5022
4791
|
readonly?: boolean;
|
|
5023
4792
|
deprecated?: boolean;
|
|
@@ -5146,10 +4915,6 @@ declare namespace Components {
|
|
|
5146
4915
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
5147
4916
|
*/
|
|
5148
4917
|
show_in_table?: boolean;
|
|
5149
|
-
/**
|
|
5150
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
5151
|
-
*/
|
|
5152
|
-
sortable?: boolean;
|
|
5153
4918
|
required?: boolean;
|
|
5154
4919
|
readonly?: boolean;
|
|
5155
4920
|
deprecated?: boolean;
|
|
@@ -5277,10 +5042,6 @@ declare namespace Components {
|
|
|
5277
5042
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
5278
5043
|
*/
|
|
5279
5044
|
show_in_table?: boolean;
|
|
5280
|
-
/**
|
|
5281
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
5282
|
-
*/
|
|
5283
|
-
sortable?: boolean;
|
|
5284
5045
|
required?: boolean;
|
|
5285
5046
|
readonly?: boolean;
|
|
5286
5047
|
deprecated?: boolean;
|
|
@@ -5471,10 +5232,6 @@ declare namespace Components {
|
|
|
5471
5232
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
5472
5233
|
*/
|
|
5473
5234
|
show_in_table?: boolean;
|
|
5474
|
-
/**
|
|
5475
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
5476
|
-
*/
|
|
5477
|
-
sortable?: boolean;
|
|
5478
5235
|
required?: boolean;
|
|
5479
5236
|
readonly?: boolean;
|
|
5480
5237
|
deprecated?: boolean;
|
|
@@ -5636,10 +5393,6 @@ declare namespace Components {
|
|
|
5636
5393
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
5637
5394
|
*/
|
|
5638
5395
|
show_in_table?: boolean;
|
|
5639
|
-
/**
|
|
5640
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
5641
|
-
*/
|
|
5642
|
-
sortable?: boolean;
|
|
5643
5396
|
required?: boolean;
|
|
5644
5397
|
readonly?: boolean;
|
|
5645
5398
|
deprecated?: boolean;
|
|
@@ -5761,10 +5514,6 @@ declare namespace Components {
|
|
|
5761
5514
|
* Render as a column in table views. When defined, overrides `hidden`
|
|
5762
5515
|
*/
|
|
5763
5516
|
show_in_table?: boolean;
|
|
5764
|
-
/**
|
|
5765
|
-
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
5766
|
-
*/
|
|
5767
|
-
sortable?: boolean;
|
|
5768
5517
|
required?: boolean;
|
|
5769
5518
|
readonly?: boolean;
|
|
5770
5519
|
deprecated?: boolean;
|
|
@@ -5876,12 +5625,6 @@ declare namespace Components {
|
|
|
5876
5625
|
declare namespace Paths {
|
|
5877
5626
|
namespace AddRelations {
|
|
5878
5627
|
namespace Parameters {
|
|
5879
|
-
export type ActivityId = /**
|
|
5880
|
-
* See https://github.com/ulid/spec
|
|
5881
|
-
* example:
|
|
5882
|
-
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
5883
|
-
*/
|
|
5884
|
-
Components.Schemas.ActivityId /* ulid */;
|
|
5885
5628
|
export type Async = boolean;
|
|
5886
5629
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
5887
5630
|
export type Slug = /**
|
|
@@ -5897,7 +5640,6 @@ declare namespace Paths {
|
|
|
5897
5640
|
}
|
|
5898
5641
|
export interface QueryParameters {
|
|
5899
5642
|
async?: Parameters.Async;
|
|
5900
|
-
activity_id?: Parameters.ActivityId;
|
|
5901
5643
|
}
|
|
5902
5644
|
export type RequestBody = Components.Schemas.RelationItem[];
|
|
5903
5645
|
namespace Responses {
|
|
@@ -6119,12 +5861,6 @@ declare namespace Paths {
|
|
|
6119
5861
|
}
|
|
6120
5862
|
namespace DeleteRelation {
|
|
6121
5863
|
namespace Parameters {
|
|
6122
|
-
export type ActivityId = /**
|
|
6123
|
-
* See https://github.com/ulid/spec
|
|
6124
|
-
* example:
|
|
6125
|
-
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
6126
|
-
*/
|
|
6127
|
-
Components.Schemas.ActivityId /* ulid */;
|
|
6128
5864
|
export type Async = boolean;
|
|
6129
5865
|
export type Attribute = string;
|
|
6130
5866
|
export type EntityId = string;
|
|
@@ -6144,7 +5880,6 @@ declare namespace Paths {
|
|
|
6144
5880
|
}
|
|
6145
5881
|
export interface QueryParameters {
|
|
6146
5882
|
async?: Parameters.Async;
|
|
6147
|
-
activity_id?: Parameters.ActivityId;
|
|
6148
5883
|
}
|
|
6149
5884
|
namespace Responses {
|
|
6150
5885
|
export interface $204 {
|
|
@@ -6339,7 +6074,6 @@ declare namespace Paths {
|
|
|
6339
6074
|
export type Before = string; // date-time
|
|
6340
6075
|
export type From = number;
|
|
6341
6076
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
6342
|
-
export type IncludeRelations = boolean;
|
|
6343
6077
|
export type Size = number;
|
|
6344
6078
|
export type Slug = /**
|
|
6345
6079
|
* URL-friendly identifier for the entity schema
|
|
@@ -6367,7 +6101,6 @@ declare namespace Paths {
|
|
|
6367
6101
|
* SyncActivity
|
|
6368
6102
|
*/
|
|
6369
6103
|
Parameters.Type;
|
|
6370
|
-
include_relations?: Parameters.IncludeRelations;
|
|
6371
6104
|
}
|
|
6372
6105
|
namespace Responses {
|
|
6373
6106
|
export interface $200 {
|
|
@@ -6380,47 +6113,11 @@ declare namespace Paths {
|
|
|
6380
6113
|
}
|
|
6381
6114
|
}
|
|
6382
6115
|
}
|
|
6383
|
-
namespace GetRelatedEntitiesCount {
|
|
6384
|
-
namespace Parameters {
|
|
6385
|
-
export type ExcludeSchemas = string[];
|
|
6386
|
-
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
6387
|
-
export type Slug = /**
|
|
6388
|
-
* URL-friendly identifier for the entity schema
|
|
6389
|
-
* example:
|
|
6390
|
-
* contact
|
|
6391
|
-
*/
|
|
6392
|
-
Components.Schemas.EntitySlug;
|
|
6393
|
-
}
|
|
6394
|
-
export interface PathParameters {
|
|
6395
|
-
slug: Parameters.Slug;
|
|
6396
|
-
id: Parameters.Id;
|
|
6397
|
-
}
|
|
6398
|
-
export interface QueryParameters {
|
|
6399
|
-
exclude_schemas?: Parameters.ExcludeSchemas;
|
|
6400
|
-
}
|
|
6401
|
-
namespace Responses {
|
|
6402
|
-
export type $200 = Components.Schemas.GetRelatedEntitiesCount;
|
|
6403
|
-
}
|
|
6404
|
-
}
|
|
6405
6116
|
namespace GetRelations {
|
|
6406
6117
|
namespace Parameters {
|
|
6407
|
-
export type ExcludeSchemas = /**
|
|
6408
|
-
* URL-friendly identifier for the entity schema
|
|
6409
|
-
* example:
|
|
6410
|
-
* contact
|
|
6411
|
-
*/
|
|
6412
|
-
Components.Schemas.EntitySlug[];
|
|
6413
|
-
export type From = number;
|
|
6414
6118
|
export type Hydrate = boolean;
|
|
6415
6119
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
6416
6120
|
export type IncludeReverse = boolean;
|
|
6417
|
-
export type IncludeSchemas = /**
|
|
6418
|
-
* URL-friendly identifier for the entity schema
|
|
6419
|
-
* example:
|
|
6420
|
-
* contact
|
|
6421
|
-
*/
|
|
6422
|
-
Components.Schemas.EntitySlug[];
|
|
6423
|
-
export type Size = number;
|
|
6424
6121
|
export type Slug = /**
|
|
6425
6122
|
* URL-friendly identifier for the entity schema
|
|
6426
6123
|
* example:
|
|
@@ -6435,10 +6132,6 @@ declare namespace Paths {
|
|
|
6435
6132
|
export interface QueryParameters {
|
|
6436
6133
|
hydrate?: Parameters.Hydrate;
|
|
6437
6134
|
include_reverse?: Parameters.IncludeReverse;
|
|
6438
|
-
from?: Parameters.From;
|
|
6439
|
-
size?: Parameters.Size;
|
|
6440
|
-
include_schemas?: Parameters.IncludeSchemas;
|
|
6441
|
-
exclude_schemas?: Parameters.ExcludeSchemas;
|
|
6442
6135
|
}
|
|
6443
6136
|
namespace Responses {
|
|
6444
6137
|
export type $200 = Components.Schemas.GetRelationsResp;
|
|
@@ -6492,48 +6185,6 @@ declare namespace Paths {
|
|
|
6492
6185
|
export type $200 = Components.Schemas.GetRelationsRespWithPagination;
|
|
6493
6186
|
}
|
|
6494
6187
|
}
|
|
6495
|
-
namespace GetRelationsV3 {
|
|
6496
|
-
namespace Parameters {
|
|
6497
|
-
export type ExcludeSchemas = /**
|
|
6498
|
-
* URL-friendly identifier for the entity schema
|
|
6499
|
-
* example:
|
|
6500
|
-
* contact
|
|
6501
|
-
*/
|
|
6502
|
-
Components.Schemas.EntitySlug[];
|
|
6503
|
-
export type From = number;
|
|
6504
|
-
export type Hydrate = boolean;
|
|
6505
|
-
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
6506
|
-
export type IncludeReverse = boolean;
|
|
6507
|
-
export type IncludeSchemas = /**
|
|
6508
|
-
* URL-friendly identifier for the entity schema
|
|
6509
|
-
* example:
|
|
6510
|
-
* contact
|
|
6511
|
-
*/
|
|
6512
|
-
Components.Schemas.EntitySlug[];
|
|
6513
|
-
export type Size = number;
|
|
6514
|
-
export type Slug = /**
|
|
6515
|
-
* URL-friendly identifier for the entity schema
|
|
6516
|
-
* example:
|
|
6517
|
-
* contact
|
|
6518
|
-
*/
|
|
6519
|
-
Components.Schemas.EntitySlug;
|
|
6520
|
-
}
|
|
6521
|
-
export interface PathParameters {
|
|
6522
|
-
slug: Parameters.Slug;
|
|
6523
|
-
id: Parameters.Id;
|
|
6524
|
-
}
|
|
6525
|
-
export interface QueryParameters {
|
|
6526
|
-
hydrate?: Parameters.Hydrate;
|
|
6527
|
-
include_reverse?: Parameters.IncludeReverse;
|
|
6528
|
-
from?: Parameters.From;
|
|
6529
|
-
size?: Parameters.Size;
|
|
6530
|
-
include_schemas?: Parameters.IncludeSchemas;
|
|
6531
|
-
exclude_schemas?: Parameters.ExcludeSchemas;
|
|
6532
|
-
}
|
|
6533
|
-
namespace Responses {
|
|
6534
|
-
export type $200 = Components.Schemas.GetRelationsRespWithPagination;
|
|
6535
|
-
}
|
|
6536
|
-
}
|
|
6537
6188
|
namespace GetSavedView {
|
|
6538
6189
|
namespace Parameters {
|
|
6539
6190
|
export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
|
|
@@ -6630,13 +6281,6 @@ declare namespace Paths {
|
|
|
6630
6281
|
}
|
|
6631
6282
|
}
|
|
6632
6283
|
}
|
|
6633
|
-
namespace ListFavoriteViewsForUser {
|
|
6634
|
-
namespace Responses {
|
|
6635
|
-
export interface $200 {
|
|
6636
|
-
results?: /* A saved entity view */ Components.Schemas.SavedViewItem[];
|
|
6637
|
-
}
|
|
6638
|
-
}
|
|
6639
|
-
}
|
|
6640
6284
|
namespace ListSavedViews {
|
|
6641
6285
|
namespace Responses {
|
|
6642
6286
|
export interface $200 {
|
|
@@ -6996,12 +6640,6 @@ declare namespace Paths {
|
|
|
6996
6640
|
}
|
|
6997
6641
|
namespace UpdateRelation {
|
|
6998
6642
|
namespace Parameters {
|
|
6999
|
-
export type ActivityId = /**
|
|
7000
|
-
* See https://github.com/ulid/spec
|
|
7001
|
-
* example:
|
|
7002
|
-
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
7003
|
-
*/
|
|
7004
|
-
Components.Schemas.ActivityId /* ulid */;
|
|
7005
6643
|
export type Async = boolean;
|
|
7006
6644
|
export type Attribute = string;
|
|
7007
6645
|
export type EntityId = string;
|
|
@@ -7021,7 +6659,6 @@ declare namespace Paths {
|
|
|
7021
6659
|
}
|
|
7022
6660
|
export interface QueryParameters {
|
|
7023
6661
|
async?: Parameters.Async;
|
|
7024
|
-
activity_id?: Parameters.ActivityId;
|
|
7025
6662
|
}
|
|
7026
6663
|
export interface RequestBody {
|
|
7027
6664
|
_tags?: string[];
|
|
@@ -7658,32 +7295,6 @@ export interface OperationMethods {
|
|
|
7658
7295
|
data?: any,
|
|
7659
7296
|
config?: AxiosRequestConfig
|
|
7660
7297
|
): OperationResponse<Paths.GetRelationsV2.Responses.$200>
|
|
7661
|
-
/**
|
|
7662
|
-
* getRelatedEntitiesCount - getRelatedEntitiesCount
|
|
7663
|
-
*
|
|
7664
|
-
* Returns the amount of unique related entities for an entity - includes direct and reverse relations.
|
|
7665
|
-
*
|
|
7666
|
-
*/
|
|
7667
|
-
'getRelatedEntitiesCount'(
|
|
7668
|
-
parameters?: Parameters<Paths.GetRelatedEntitiesCount.PathParameters & Paths.GetRelatedEntitiesCount.QueryParameters> | null,
|
|
7669
|
-
data?: any,
|
|
7670
|
-
config?: AxiosRequestConfig
|
|
7671
|
-
): OperationResponse<Paths.GetRelatedEntitiesCount.Responses.$200>
|
|
7672
|
-
/**
|
|
7673
|
-
* getRelationsV3 - getRelationsV3
|
|
7674
|
-
*
|
|
7675
|
-
* Returns 1st level direct relations for an entity with pagination.
|
|
7676
|
-
*
|
|
7677
|
-
* You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
|
|
7678
|
-
*
|
|
7679
|
-
* Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
|
|
7680
|
-
*
|
|
7681
|
-
*/
|
|
7682
|
-
'getRelationsV3'(
|
|
7683
|
-
parameters?: Parameters<Paths.GetRelationsV3.PathParameters & Paths.GetRelationsV3.QueryParameters> | null,
|
|
7684
|
-
data?: any,
|
|
7685
|
-
config?: AxiosRequestConfig
|
|
7686
|
-
): OperationResponse<Paths.GetRelationsV3.Responses.$200>
|
|
7687
7298
|
/**
|
|
7688
7299
|
* updateRelation - updateRelation
|
|
7689
7300
|
*
|
|
@@ -7777,16 +7388,6 @@ export interface OperationMethods {
|
|
|
7777
7388
|
data?: any,
|
|
7778
7389
|
config?: AxiosRequestConfig
|
|
7779
7390
|
): OperationResponse<Paths.DeleteSavedView.Responses.$200>
|
|
7780
|
-
/**
|
|
7781
|
-
* listFavoriteViewsForUser - listFavoriteViewsForUser
|
|
7782
|
-
*
|
|
7783
|
-
* Get the Favorite Saved Views for user based on the schema
|
|
7784
|
-
*/
|
|
7785
|
-
'listFavoriteViewsForUser'(
|
|
7786
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
7787
|
-
data?: any,
|
|
7788
|
-
config?: AxiosRequestConfig
|
|
7789
|
-
): OperationResponse<Paths.ListFavoriteViewsForUser.Responses.$200>
|
|
7790
7391
|
/**
|
|
7791
7392
|
* listTaxonomies - listTaxonomies
|
|
7792
7393
|
*
|
|
@@ -8327,36 +7928,6 @@ export interface PathsDictionary {
|
|
|
8327
7928
|
config?: AxiosRequestConfig
|
|
8328
7929
|
): OperationResponse<Paths.GetRelationsV2.Responses.$200>
|
|
8329
7930
|
}
|
|
8330
|
-
['/v2/entity/{slug}/{id}/relations/count']: {
|
|
8331
|
-
/**
|
|
8332
|
-
* getRelatedEntitiesCount - getRelatedEntitiesCount
|
|
8333
|
-
*
|
|
8334
|
-
* Returns the amount of unique related entities for an entity - includes direct and reverse relations.
|
|
8335
|
-
*
|
|
8336
|
-
*/
|
|
8337
|
-
'get'(
|
|
8338
|
-
parameters?: Parameters<Paths.GetRelatedEntitiesCount.PathParameters & Paths.GetRelatedEntitiesCount.QueryParameters> | null,
|
|
8339
|
-
data?: any,
|
|
8340
|
-
config?: AxiosRequestConfig
|
|
8341
|
-
): OperationResponse<Paths.GetRelatedEntitiesCount.Responses.$200>
|
|
8342
|
-
}
|
|
8343
|
-
['/v3/entity/{slug}/{id}/relations']: {
|
|
8344
|
-
/**
|
|
8345
|
-
* getRelationsV3 - getRelationsV3
|
|
8346
|
-
*
|
|
8347
|
-
* Returns 1st level direct relations for an entity with pagination.
|
|
8348
|
-
*
|
|
8349
|
-
* You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
|
|
8350
|
-
*
|
|
8351
|
-
* Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
|
|
8352
|
-
*
|
|
8353
|
-
*/
|
|
8354
|
-
'get'(
|
|
8355
|
-
parameters?: Parameters<Paths.GetRelationsV3.PathParameters & Paths.GetRelationsV3.QueryParameters> | null,
|
|
8356
|
-
data?: any,
|
|
8357
|
-
config?: AxiosRequestConfig
|
|
8358
|
-
): OperationResponse<Paths.GetRelationsV3.Responses.$200>
|
|
8359
|
-
}
|
|
8360
7931
|
['/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}']: {
|
|
8361
7932
|
/**
|
|
8362
7933
|
* updateRelation - updateRelation
|
|
@@ -8462,18 +8033,6 @@ export interface PathsDictionary {
|
|
|
8462
8033
|
config?: AxiosRequestConfig
|
|
8463
8034
|
): OperationResponse<Paths.DeleteSavedView.Responses.$200>
|
|
8464
8035
|
}
|
|
8465
|
-
['/v1/entity/views/favorites']: {
|
|
8466
|
-
/**
|
|
8467
|
-
* listFavoriteViewsForUser - listFavoriteViewsForUser
|
|
8468
|
-
*
|
|
8469
|
-
* Get the Favorite Saved Views for user based on the schema
|
|
8470
|
-
*/
|
|
8471
|
-
'get'(
|
|
8472
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
8473
|
-
data?: any,
|
|
8474
|
-
config?: AxiosRequestConfig
|
|
8475
|
-
): OperationResponse<Paths.ListFavoriteViewsForUser.Responses.$200>
|
|
8476
|
-
}
|
|
8477
8036
|
['/v1/entity/listTaxonomies']: {
|
|
8478
8037
|
/**
|
|
8479
8038
|
* listTaxonomies - listTaxonomies
|