@epilot/entity-client 4.36.0 → 4.38.0-alpha.0

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/openapi.d.ts CHANGED
@@ -397,6 +397,11 @@ declare namespace Components {
397
397
  */
398
398
  hint_tooltip_placement?: string;
399
399
  };
400
+ /**
401
+ * The attribute is a repeatable
402
+ */
403
+ repeatable?: boolean;
404
+ has_primary?: boolean;
400
405
  type?: "address";
401
406
  default_address_fields?: /* Default fields visible on addresses */ DefaultAddressFields;
402
407
  }
@@ -534,11 +539,15 @@ declare namespace Components {
534
539
  */
535
540
  hint_tooltip_placement?: string;
536
541
  };
537
- type?: "relation_address";
542
+ /**
543
+ * The attribute is a repeatable
544
+ */
545
+ repeatable?: boolean;
538
546
  has_primary?: boolean;
547
+ type?: "relation_address";
539
548
  default_address_fields?: /* Default fields visible on addresses */ DefaultAddressFields;
540
549
  }
541
- 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 | /* Address attribute */ AddressAttribute | /* 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 | /* Message emil address */ MessageEmailAddressAttribute | /* 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 | /* Shared Partner Organisations */ PartnerOrganisationAttribute;
550
+ 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 | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* 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 | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute;
542
551
  /**
543
552
  * a readonly computed ID for the attribute including schema slug and the attribute ID
544
553
  */
@@ -554,7 +563,7 @@ declare namespace Components {
554
563
  * contact
555
564
  */
556
565
  schema?: string;
557
- } & (/* a readonly computed ID for the attribute including schema slug and the attribute ID */ /* 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 | /* Address attribute */ AddressAttribute | /* 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 | /* Message emil address */ MessageEmailAddressAttribute | /* 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 | /* Shared Partner Organisations */ PartnerOrganisationAttribute);
566
+ } & (/* a readonly computed ID for the attribute including schema slug and the attribute ID */ /* 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 | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* 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 | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute);
558
567
  /**
559
568
  * Automation entity
560
569
  */
@@ -689,6 +698,11 @@ declare namespace Components {
689
698
  */
690
699
  hint_tooltip_placement?: string;
691
700
  };
701
+ /**
702
+ * The attribute is a repeatable
703
+ */
704
+ repeatable?: boolean;
705
+ has_primary?: boolean;
692
706
  type?: "automation";
693
707
  }
694
708
  export interface BaseActivityItem {
@@ -867,6 +881,11 @@ declare namespace Components {
867
881
  */
868
882
  hint_tooltip_placement?: string;
869
883
  };
884
+ /**
885
+ * The attribute is a repeatable
886
+ */
887
+ repeatable?: boolean;
888
+ has_primary?: boolean;
870
889
  }
871
890
  /**
872
891
  * example:
@@ -1076,7 +1095,13 @@ declare namespace Components {
1076
1095
  */
1077
1096
  hint_tooltip_placement?: string;
1078
1097
  };
1098
+ /**
1099
+ * The attribute is a repeatable
1100
+ */
1101
+ repeatable?: boolean;
1102
+ has_primary?: boolean;
1079
1103
  type?: "boolean";
1104
+ display_type?: "switch" | "checkbox";
1080
1105
  }
1081
1106
  /**
1082
1107
  * example:
@@ -1190,7 +1215,17 @@ declare namespace Components {
1190
1215
  * This attribute should only be active when one of the provided settings have the correct value
1191
1216
  */
1192
1217
  settings_flag?: SettingFlag[];
1193
- value_formatter?: string;
1218
+ /**
1219
+ * Variable template used to format the computed value
1220
+ * example:
1221
+ * {{formatCurrencyAttribute entity attribute locale}}
1222
+ */
1223
+ value_formatter: string;
1224
+ /**
1225
+ * Variable template used to format a preview for the computed value
1226
+ * example:
1227
+ * {{formatCurrencyAttribute entity attribute locale}}
1228
+ */
1194
1229
  preview_value_formatter?: string;
1195
1230
  /**
1196
1231
  * Setting to `true` disables editing the attribute on the entity builder UI
@@ -1232,7 +1267,21 @@ declare namespace Components {
1232
1267
  */
1233
1268
  hint_tooltip_placement?: string;
1234
1269
  };
1270
+ /**
1271
+ * The attribute is a repeatable
1272
+ */
1273
+ repeatable?: boolean;
1274
+ has_primary?: boolean;
1235
1275
  type?: "computed";
1276
+ computed?: boolean;
1277
+ /**
1278
+ * A source amount field that is used to compute the value of the attribute
1279
+ */
1280
+ amount_field?: string;
1281
+ /**
1282
+ * A currency field used to format a computed currency value
1283
+ */
1284
+ currency_field?: string;
1236
1285
  }
1237
1286
  /**
1238
1287
  * Consent Management
@@ -1368,6 +1417,11 @@ declare namespace Components {
1368
1417
  */
1369
1418
  hint_tooltip_placement?: string;
1370
1419
  };
1420
+ /**
1421
+ * The attribute is a repeatable
1422
+ */
1423
+ repeatable?: boolean;
1424
+ has_primary?: boolean;
1371
1425
  type: "consent";
1372
1426
  topic: string;
1373
1427
  identifiers?: string[];
@@ -1506,6 +1560,11 @@ declare namespace Components {
1506
1560
  */
1507
1561
  hint_tooltip_placement?: string;
1508
1562
  };
1563
+ /**
1564
+ * The attribute is a repeatable
1565
+ */
1566
+ repeatable?: boolean;
1567
+ has_primary?: boolean;
1509
1568
  type?: "country";
1510
1569
  }
1511
1570
  /**
@@ -1642,6 +1701,11 @@ declare namespace Components {
1642
1701
  */
1643
1702
  hint_tooltip_placement?: string;
1644
1703
  };
1704
+ /**
1705
+ * The attribute is a repeatable
1706
+ */
1707
+ repeatable?: boolean;
1708
+ has_primary?: boolean;
1645
1709
  type: "currency";
1646
1710
  currency_selector_only?: boolean;
1647
1711
  /**
@@ -1788,6 +1852,11 @@ declare namespace Components {
1788
1852
  */
1789
1853
  hint_tooltip_placement?: string;
1790
1854
  };
1855
+ /**
1856
+ * The attribute is a repeatable
1857
+ */
1858
+ repeatable?: boolean;
1859
+ has_primary?: boolean;
1791
1860
  type?: "date" | "datetime";
1792
1861
  }
1793
1862
  /**
@@ -1804,6 +1873,147 @@ declare namespace Components {
1804
1873
  */
1805
1874
  cluster?: string;
1806
1875
  }
1876
+ /**
1877
+ * Email address
1878
+ */
1879
+ export interface EmailAttribute {
1880
+ /**
1881
+ * ID for the entity attribute
1882
+ * example:
1883
+ * d5839b94-ba20-4225-a78e-76951d352bd6
1884
+ */
1885
+ id?: string;
1886
+ name: string;
1887
+ label: string;
1888
+ placeholder?: string;
1889
+ /**
1890
+ * Do not render attribute in entity views
1891
+ */
1892
+ hidden?: boolean;
1893
+ /**
1894
+ * Render as a column in table views. When defined, overrides `hidden`
1895
+ */
1896
+ show_in_table?: boolean;
1897
+ /**
1898
+ * Allow sorting by this attribute in table views if `show_in_table` is true
1899
+ */
1900
+ sortable?: boolean;
1901
+ required?: boolean;
1902
+ readonly?: boolean;
1903
+ deprecated?: boolean;
1904
+ default_value?: any;
1905
+ /**
1906
+ * Which group the attribute should appear in. Accepts group ID or group name
1907
+ */
1908
+ group?: string;
1909
+ /**
1910
+ * Attribute sort order (ascending) in group
1911
+ * example:
1912
+ * 0
1913
+ */
1914
+ order?: number;
1915
+ /**
1916
+ * example:
1917
+ * full_width
1918
+ */
1919
+ layout?: string;
1920
+ /**
1921
+ * When set to true, will hide the label of the field.
1922
+ */
1923
+ hide_label?: boolean;
1924
+ /**
1925
+ * Code name of the icon to used to represent this attribute.
1926
+ * The value must be a valid @epilot/base-elements Icon name
1927
+ *
1928
+ */
1929
+ icon?: string;
1930
+ /**
1931
+ * Defines the conditional rendering expression for showing this field.
1932
+ * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
1933
+ * Note: Empty or invalid expression have no effect on the field visibility.
1934
+ *
1935
+ */
1936
+ render_condition?: string;
1937
+ _purpose?: /**
1938
+ * example:
1939
+ * taxonomy-slug:classification-slug
1940
+ */
1941
+ ClassificationId[];
1942
+ /**
1943
+ * Manifest ID used to create/update the schema attribute
1944
+ */
1945
+ _manifest?: string /* uuid */[] | null;
1946
+ /**
1947
+ * A set of constraints applicable to the attribute.
1948
+ * These constraints should and will be enforced by the attribute renderer.
1949
+ *
1950
+ * example:
1951
+ * {
1952
+ * "disablePast": true
1953
+ * }
1954
+ */
1955
+ constraints?: {
1956
+ [key: string]: any;
1957
+ };
1958
+ /**
1959
+ * This attribute should only be active when the feature flag is enabled
1960
+ * example:
1961
+ * FF_MY_FEATURE_FLAG
1962
+ */
1963
+ feature_flag?: string;
1964
+ /**
1965
+ * This attribute should only be active when one of the provided settings have the correct value
1966
+ */
1967
+ settings_flag?: SettingFlag[];
1968
+ value_formatter?: string;
1969
+ preview_value_formatter?: string;
1970
+ /**
1971
+ * Setting to `true` disables editing the attribute on the entity builder UI
1972
+ */
1973
+ entity_builder_disable_edit?: boolean;
1974
+ /**
1975
+ * Setting to `true` prevents the attribute from being modified / deleted
1976
+ */
1977
+ protected?: boolean;
1978
+ /**
1979
+ * A set of configurations meant to document and assist the user in filling the attribute.
1980
+ */
1981
+ info_helpers?: {
1982
+ /**
1983
+ * The text to be displayed in the attribute hint helper.
1984
+ * When specified it overrides the `hint_text_key` configuration.
1985
+ *
1986
+ */
1987
+ hint_text?: string;
1988
+ /**
1989
+ * The key of the hint text to be displayed in the attribute hint helper.
1990
+ * The key should be a valid i18n key.
1991
+ *
1992
+ */
1993
+ hint_text_key?: string;
1994
+ /**
1995
+ * The name of the custom component to be used as the hint helper.
1996
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
1997
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
1998
+ *
1999
+ */
2000
+ hint_custom_component?: string;
2001
+ /**
2002
+ * The placement of the hint tooltip.
2003
+ * The value should be a valid `@mui/core` tooltip placement.
2004
+ *
2005
+ * example:
2006
+ * top
2007
+ */
2008
+ hint_tooltip_placement?: string;
2009
+ };
2010
+ /**
2011
+ * The attribute is a repeatable
2012
+ */
2013
+ repeatable?: boolean;
2014
+ has_primary?: boolean;
2015
+ type?: "email";
2016
+ }
1807
2017
  /**
1808
2018
  * example:
1809
2019
  * {
@@ -3793,6 +4003,11 @@ declare namespace Components {
3793
4003
  */
3794
4004
  hint_tooltip_placement?: string;
3795
4005
  };
4006
+ /**
4007
+ * The attribute is a repeatable
4008
+ */
4009
+ repeatable?: boolean;
4010
+ has_primary?: boolean;
3796
4011
  type: "image" | "file";
3797
4012
  multiple?: boolean;
3798
4013
  /**
@@ -4274,6 +4489,11 @@ declare namespace Components {
4274
4489
  */
4275
4490
  hint_tooltip_placement?: string;
4276
4491
  };
4492
+ /**
4493
+ * The attribute is a repeatable
4494
+ */
4495
+ repeatable?: boolean;
4496
+ has_primary?: boolean;
4277
4497
  type?: "internal";
4278
4498
  }
4279
4499
  /**
@@ -4410,6 +4630,11 @@ declare namespace Components {
4410
4630
  */
4411
4631
  hint_tooltip_placement?: string;
4412
4632
  };
4633
+ /**
4634
+ * The attribute is a repeatable
4635
+ */
4636
+ repeatable?: boolean;
4637
+ has_primary?: boolean;
4413
4638
  type?: "internal_user";
4414
4639
  }
4415
4640
  /**
@@ -4546,20 +4771,475 @@ declare namespace Components {
4546
4771
  */
4547
4772
  hint_tooltip_placement?: string;
4548
4773
  };
4774
+ /**
4775
+ * The attribute is a repeatable
4776
+ */
4777
+ repeatable?: boolean;
4778
+ has_primary?: boolean;
4549
4779
  type?: "invitation_email";
4550
4780
  }
4551
4781
  /**
4552
- * Pass 'true' to generate import template
4553
- */
4554
- export type IsTemplate = boolean;
4555
- /**
4556
- * Export headers translation Language
4557
- */
4558
- export type Language = string;
4559
- /**
4560
- * Link with title and href
4782
+ * Pass 'true' to generate import template
4783
+ */
4784
+ export type IsTemplate = boolean;
4785
+ /**
4786
+ * Export headers translation Language
4787
+ */
4788
+ export type Language = string;
4789
+ /**
4790
+ * Link with title and href
4791
+ */
4792
+ export interface LinkAttribute {
4793
+ /**
4794
+ * ID for the entity attribute
4795
+ * example:
4796
+ * d5839b94-ba20-4225-a78e-76951d352bd6
4797
+ */
4798
+ id?: string;
4799
+ name: string;
4800
+ label: string;
4801
+ placeholder?: string;
4802
+ /**
4803
+ * Do not render attribute in entity views
4804
+ */
4805
+ hidden?: boolean;
4806
+ /**
4807
+ * Render as a column in table views. When defined, overrides `hidden`
4808
+ */
4809
+ show_in_table?: boolean;
4810
+ /**
4811
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4812
+ */
4813
+ sortable?: boolean;
4814
+ required?: boolean;
4815
+ readonly?: boolean;
4816
+ deprecated?: boolean;
4817
+ default_value?: any;
4818
+ /**
4819
+ * Which group the attribute should appear in. Accepts group ID or group name
4820
+ */
4821
+ group?: string;
4822
+ /**
4823
+ * Attribute sort order (ascending) in group
4824
+ * example:
4825
+ * 0
4826
+ */
4827
+ order?: number;
4828
+ /**
4829
+ * example:
4830
+ * full_width
4831
+ */
4832
+ layout?: string;
4833
+ /**
4834
+ * When set to true, will hide the label of the field.
4835
+ */
4836
+ hide_label?: boolean;
4837
+ /**
4838
+ * Code name of the icon to used to represent this attribute.
4839
+ * The value must be a valid @epilot/base-elements Icon name
4840
+ *
4841
+ */
4842
+ icon?: string;
4843
+ /**
4844
+ * Defines the conditional rendering expression for showing this field.
4845
+ * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
4846
+ * Note: Empty or invalid expression have no effect on the field visibility.
4847
+ *
4848
+ */
4849
+ render_condition?: string;
4850
+ _purpose?: /**
4851
+ * example:
4852
+ * taxonomy-slug:classification-slug
4853
+ */
4854
+ ClassificationId[];
4855
+ /**
4856
+ * Manifest ID used to create/update the schema attribute
4857
+ */
4858
+ _manifest?: string /* uuid */[] | null;
4859
+ /**
4860
+ * A set of constraints applicable to the attribute.
4861
+ * These constraints should and will be enforced by the attribute renderer.
4862
+ *
4863
+ * example:
4864
+ * {
4865
+ * "disablePast": true
4866
+ * }
4867
+ */
4868
+ constraints?: {
4869
+ [key: string]: any;
4870
+ };
4871
+ /**
4872
+ * This attribute should only be active when the feature flag is enabled
4873
+ * example:
4874
+ * FF_MY_FEATURE_FLAG
4875
+ */
4876
+ feature_flag?: string;
4877
+ /**
4878
+ * This attribute should only be active when one of the provided settings have the correct value
4879
+ */
4880
+ settings_flag?: SettingFlag[];
4881
+ value_formatter?: string;
4882
+ preview_value_formatter?: string;
4883
+ /**
4884
+ * Setting to `true` disables editing the attribute on the entity builder UI
4885
+ */
4886
+ entity_builder_disable_edit?: boolean;
4887
+ /**
4888
+ * Setting to `true` prevents the attribute from being modified / deleted
4889
+ */
4890
+ protected?: boolean;
4891
+ /**
4892
+ * A set of configurations meant to document and assist the user in filling the attribute.
4893
+ */
4894
+ info_helpers?: {
4895
+ /**
4896
+ * The text to be displayed in the attribute hint helper.
4897
+ * When specified it overrides the `hint_text_key` configuration.
4898
+ *
4899
+ */
4900
+ hint_text?: string;
4901
+ /**
4902
+ * The key of the hint text to be displayed in the attribute hint helper.
4903
+ * The key should be a valid i18n key.
4904
+ *
4905
+ */
4906
+ hint_text_key?: string;
4907
+ /**
4908
+ * The name of the custom component to be used as the hint helper.
4909
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
4910
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
4911
+ *
4912
+ */
4913
+ hint_custom_component?: string;
4914
+ /**
4915
+ * The placement of the hint tooltip.
4916
+ * The value should be a valid `@mui/core` tooltip placement.
4917
+ *
4918
+ * example:
4919
+ * top
4920
+ */
4921
+ hint_tooltip_placement?: string;
4922
+ };
4923
+ /**
4924
+ * The attribute is a repeatable
4925
+ */
4926
+ repeatable?: boolean;
4927
+ has_primary?: boolean;
4928
+ type?: "link";
4929
+ }
4930
+ export interface ListSavedViewsResults {
4931
+ /**
4932
+ * example:
4933
+ * 1
4934
+ */
4935
+ hits?: number;
4936
+ results?: /* A saved entity view */ SavedViewItem[];
4937
+ }
4938
+ /**
4939
+ * Message emil address
4940
+ */
4941
+ export interface MessageEmailAddressAttribute {
4942
+ /**
4943
+ * ID for the entity attribute
4944
+ * example:
4945
+ * d5839b94-ba20-4225-a78e-76951d352bd6
4946
+ */
4947
+ id?: string;
4948
+ name: string;
4949
+ label: string;
4950
+ placeholder?: string;
4951
+ /**
4952
+ * Do not render attribute in entity views
4953
+ */
4954
+ hidden?: boolean;
4955
+ /**
4956
+ * Render as a column in table views. When defined, overrides `hidden`
4957
+ */
4958
+ show_in_table?: boolean;
4959
+ /**
4960
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4961
+ */
4962
+ sortable?: boolean;
4963
+ required?: boolean;
4964
+ readonly?: boolean;
4965
+ deprecated?: boolean;
4966
+ default_value?: any;
4967
+ /**
4968
+ * Which group the attribute should appear in. Accepts group ID or group name
4969
+ */
4970
+ group?: string;
4971
+ /**
4972
+ * Attribute sort order (ascending) in group
4973
+ * example:
4974
+ * 0
4975
+ */
4976
+ order?: number;
4977
+ /**
4978
+ * example:
4979
+ * full_width
4980
+ */
4981
+ layout?: string;
4982
+ /**
4983
+ * When set to true, will hide the label of the field.
4984
+ */
4985
+ hide_label?: boolean;
4986
+ /**
4987
+ * Code name of the icon to used to represent this attribute.
4988
+ * The value must be a valid @epilot/base-elements Icon name
4989
+ *
4990
+ */
4991
+ icon?: string;
4992
+ /**
4993
+ * Defines the conditional rendering expression for showing this field.
4994
+ * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
4995
+ * Note: Empty or invalid expression have no effect on the field visibility.
4996
+ *
4997
+ */
4998
+ render_condition?: string;
4999
+ _purpose?: /**
5000
+ * example:
5001
+ * taxonomy-slug:classification-slug
5002
+ */
5003
+ ClassificationId[];
5004
+ /**
5005
+ * Manifest ID used to create/update the schema attribute
5006
+ */
5007
+ _manifest?: string /* uuid */[] | null;
5008
+ /**
5009
+ * A set of constraints applicable to the attribute.
5010
+ * These constraints should and will be enforced by the attribute renderer.
5011
+ *
5012
+ * example:
5013
+ * {
5014
+ * "disablePast": true
5015
+ * }
5016
+ */
5017
+ constraints?: {
5018
+ [key: string]: any;
5019
+ };
5020
+ /**
5021
+ * This attribute should only be active when the feature flag is enabled
5022
+ * example:
5023
+ * FF_MY_FEATURE_FLAG
5024
+ */
5025
+ feature_flag?: string;
5026
+ /**
5027
+ * This attribute should only be active when one of the provided settings have the correct value
5028
+ */
5029
+ settings_flag?: SettingFlag[];
5030
+ value_formatter?: string;
5031
+ preview_value_formatter?: string;
5032
+ /**
5033
+ * Setting to `true` disables editing the attribute on the entity builder UI
5034
+ */
5035
+ entity_builder_disable_edit?: boolean;
5036
+ /**
5037
+ * Setting to `true` prevents the attribute from being modified / deleted
5038
+ */
5039
+ protected?: boolean;
5040
+ /**
5041
+ * A set of configurations meant to document and assist the user in filling the attribute.
5042
+ */
5043
+ info_helpers?: {
5044
+ /**
5045
+ * The text to be displayed in the attribute hint helper.
5046
+ * When specified it overrides the `hint_text_key` configuration.
5047
+ *
5048
+ */
5049
+ hint_text?: string;
5050
+ /**
5051
+ * The key of the hint text to be displayed in the attribute hint helper.
5052
+ * The key should be a valid i18n key.
5053
+ *
5054
+ */
5055
+ hint_text_key?: string;
5056
+ /**
5057
+ * The name of the custom component to be used as the hint helper.
5058
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
5059
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
5060
+ *
5061
+ */
5062
+ hint_custom_component?: string;
5063
+ /**
5064
+ * The placement of the hint tooltip.
5065
+ * The value should be a valid `@mui/core` tooltip placement.
5066
+ *
5067
+ * example:
5068
+ * top
5069
+ */
5070
+ hint_tooltip_placement?: string;
5071
+ };
5072
+ /**
5073
+ * The attribute is a repeatable
5074
+ */
5075
+ repeatable?: boolean;
5076
+ has_primary?: boolean;
5077
+ type: "message_email_address";
5078
+ address?: string;
5079
+ send_status?: string;
5080
+ email_type?: string;
5081
+ }
5082
+ /**
5083
+ * Multi Choice Selection
5084
+ */
5085
+ export interface MultiSelectAttribute {
5086
+ /**
5087
+ * ID for the entity attribute
5088
+ * example:
5089
+ * d5839b94-ba20-4225-a78e-76951d352bd6
5090
+ */
5091
+ id?: string;
5092
+ name: string;
5093
+ label: string;
5094
+ placeholder?: string;
5095
+ /**
5096
+ * Do not render attribute in entity views
5097
+ */
5098
+ hidden?: boolean;
5099
+ /**
5100
+ * Render as a column in table views. When defined, overrides `hidden`
5101
+ */
5102
+ show_in_table?: boolean;
5103
+ /**
5104
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5105
+ */
5106
+ sortable?: boolean;
5107
+ required?: boolean;
5108
+ readonly?: boolean;
5109
+ deprecated?: boolean;
5110
+ default_value?: any;
5111
+ /**
5112
+ * Which group the attribute should appear in. Accepts group ID or group name
5113
+ */
5114
+ group?: string;
5115
+ /**
5116
+ * Attribute sort order (ascending) in group
5117
+ * example:
5118
+ * 0
5119
+ */
5120
+ order?: number;
5121
+ /**
5122
+ * example:
5123
+ * full_width
5124
+ */
5125
+ layout?: string;
5126
+ /**
5127
+ * When set to true, will hide the label of the field.
5128
+ */
5129
+ hide_label?: boolean;
5130
+ /**
5131
+ * Code name of the icon to used to represent this attribute.
5132
+ * The value must be a valid @epilot/base-elements Icon name
5133
+ *
5134
+ */
5135
+ icon?: string;
5136
+ /**
5137
+ * Defines the conditional rendering expression for showing this field.
5138
+ * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
5139
+ * Note: Empty or invalid expression have no effect on the field visibility.
5140
+ *
5141
+ */
5142
+ render_condition?: string;
5143
+ _purpose?: /**
5144
+ * example:
5145
+ * taxonomy-slug:classification-slug
5146
+ */
5147
+ ClassificationId[];
5148
+ /**
5149
+ * Manifest ID used to create/update the schema attribute
5150
+ */
5151
+ _manifest?: string /* uuid */[] | null;
5152
+ /**
5153
+ * A set of constraints applicable to the attribute.
5154
+ * These constraints should and will be enforced by the attribute renderer.
5155
+ *
5156
+ * example:
5157
+ * {
5158
+ * "disablePast": true
5159
+ * }
5160
+ */
5161
+ constraints?: {
5162
+ [key: string]: any;
5163
+ };
5164
+ /**
5165
+ * This attribute should only be active when the feature flag is enabled
5166
+ * example:
5167
+ * FF_MY_FEATURE_FLAG
5168
+ */
5169
+ feature_flag?: string;
5170
+ /**
5171
+ * This attribute should only be active when one of the provided settings have the correct value
5172
+ */
5173
+ settings_flag?: SettingFlag[];
5174
+ value_formatter?: string;
5175
+ preview_value_formatter?: string;
5176
+ /**
5177
+ * Setting to `true` disables editing the attribute on the entity builder UI
5178
+ */
5179
+ entity_builder_disable_edit?: boolean;
5180
+ /**
5181
+ * Setting to `true` prevents the attribute from being modified / deleted
5182
+ */
5183
+ protected?: boolean;
5184
+ /**
5185
+ * A set of configurations meant to document and assist the user in filling the attribute.
5186
+ */
5187
+ info_helpers?: {
5188
+ /**
5189
+ * The text to be displayed in the attribute hint helper.
5190
+ * When specified it overrides the `hint_text_key` configuration.
5191
+ *
5192
+ */
5193
+ hint_text?: string;
5194
+ /**
5195
+ * The key of the hint text to be displayed in the attribute hint helper.
5196
+ * The key should be a valid i18n key.
5197
+ *
5198
+ */
5199
+ hint_text_key?: string;
5200
+ /**
5201
+ * The name of the custom component to be used as the hint helper.
5202
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
5203
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
5204
+ *
5205
+ */
5206
+ hint_custom_component?: string;
5207
+ /**
5208
+ * The placement of the hint tooltip.
5209
+ * The value should be a valid `@mui/core` tooltip placement.
5210
+ *
5211
+ * example:
5212
+ * top
5213
+ */
5214
+ hint_tooltip_placement?: string;
5215
+ };
5216
+ /**
5217
+ * The attribute is a repeatable
5218
+ */
5219
+ repeatable?: boolean;
5220
+ has_primary?: boolean;
5221
+ type?: "multiselect" | "checkbox";
5222
+ /**
5223
+ * controls if the matching of values against the options is case sensitive or not
5224
+ */
5225
+ disable_case_sensitive?: boolean | null;
5226
+ /**
5227
+ * controls if the 360 ui will allow the user to enter a value which is not defined by the options
5228
+ */
5229
+ allow_extra_options?: boolean | null;
5230
+ options?: ((string | null) | {
5231
+ value: string;
5232
+ title?: string;
5233
+ })[];
5234
+ /**
5235
+ * Allow arbitrary input values in addition to provided options
5236
+ */
5237
+ allow_any?: boolean;
5238
+ }
5239
+ /**
5240
+ * Numeric input
4561
5241
  */
4562
- export interface LinkAttribute {
5242
+ export interface NumberAttribute {
4563
5243
  /**
4564
5244
  * ID for the entity attribute
4565
5245
  * example:
@@ -4690,20 +5370,22 @@ declare namespace Components {
4690
5370
  */
4691
5371
  hint_tooltip_placement?: string;
4692
5372
  };
4693
- type?: "link";
4694
- }
4695
- export interface ListSavedViewsResults {
4696
5373
  /**
4697
- * example:
4698
- * 1
5374
+ * The attribute is a repeatable
4699
5375
  */
4700
- hits?: number;
4701
- results?: /* A saved entity view */ SavedViewItem[];
5376
+ repeatable?: boolean;
5377
+ has_primary?: boolean;
5378
+ type?: "number";
5379
+ format?: string;
5380
+ /**
5381
+ * Whether or not to show a thousands separator
5382
+ */
5383
+ show_separator?: boolean;
4702
5384
  }
4703
5385
  /**
4704
- * Message emil address
5386
+ * Type of attribute to render N number of ordered fields
4705
5387
  */
4706
- export interface MessageEmailAddressAttribute {
5388
+ export interface OrderedListAttribute {
4707
5389
  /**
4708
5390
  * ID for the entity attribute
4709
5391
  * example:
@@ -4834,15 +5516,17 @@ declare namespace Components {
4834
5516
  */
4835
5517
  hint_tooltip_placement?: string;
4836
5518
  };
4837
- type: "message_email_address";
4838
- address: string;
4839
- send_status?: string;
4840
- email_type?: string;
5519
+ /**
5520
+ * The attribute is a repeatable
5521
+ */
5522
+ repeatable?: boolean;
5523
+ has_primary?: boolean;
5524
+ type?: "ordered_list";
4841
5525
  }
4842
5526
  /**
4843
- * Multi Choice Selection
5527
+ * Shared Partner Organisations
4844
5528
  */
4845
- export interface MultiSelectAttribute {
5529
+ export interface PartnerOrganisationAttribute {
4846
5530
  /**
4847
5531
  * ID for the entity attribute
4848
5532
  * example:
@@ -4973,28 +5657,17 @@ declare namespace Components {
4973
5657
  */
4974
5658
  hint_tooltip_placement?: string;
4975
5659
  };
4976
- type?: "multiselect" | "checkbox";
4977
- /**
4978
- * controls if the matching of values against the options is case sensitive or not
4979
- */
4980
- disable_case_sensitive?: boolean | null;
4981
- /**
4982
- * controls if the 360 ui will allow the user to enter a value which is not defined by the options
4983
- */
4984
- allow_extra_options?: boolean | null;
4985
- options?: ((string | null) | {
4986
- value: string;
4987
- title?: string;
4988
- })[];
4989
5660
  /**
4990
- * Allow arbitrary input values in addition to provided options
5661
+ * The attribute is a repeatable
4991
5662
  */
4992
- allow_any?: boolean;
5663
+ repeatable?: boolean;
5664
+ has_primary?: boolean;
5665
+ type?: "partner_organisation";
4993
5666
  }
4994
5667
  /**
4995
- * Numeric input
5668
+ * Partner Status
4996
5669
  */
4997
- export interface NumberAttribute {
5670
+ export interface PartnerStatusAttribute {
4998
5671
  /**
4999
5672
  * ID for the entity attribute
5000
5673
  * example:
@@ -5125,17 +5798,17 @@ declare namespace Components {
5125
5798
  */
5126
5799
  hint_tooltip_placement?: string;
5127
5800
  };
5128
- type?: "number";
5129
- format?: string;
5130
5801
  /**
5131
- * Whether or not to show a thousands separator
5802
+ * The attribute is a repeatable
5132
5803
  */
5133
- show_separator?: boolean;
5804
+ repeatable?: boolean;
5805
+ has_primary?: boolean;
5806
+ type?: "partner_status";
5134
5807
  }
5135
5808
  /**
5136
- * Type of attribute to render N number of ordered fields
5809
+ * Payment method
5137
5810
  */
5138
- export interface OrderedListAttribute {
5811
+ export interface PaymentAttribute {
5139
5812
  /**
5140
5813
  * ID for the entity attribute
5141
5814
  * example:
@@ -5266,12 +5939,17 @@ declare namespace Components {
5266
5939
  */
5267
5940
  hint_tooltip_placement?: string;
5268
5941
  };
5269
- type?: "ordered_list";
5942
+ /**
5943
+ * The attribute is a repeatable
5944
+ */
5945
+ repeatable?: boolean;
5946
+ has_primary?: boolean;
5947
+ type?: "payment";
5270
5948
  }
5271
5949
  /**
5272
- * Shared Partner Organisations
5950
+ * Reference to a payment method attribute of another entity
5273
5951
  */
5274
- export interface PartnerOrganisationAttribute {
5952
+ export interface PaymentMethodRelationAttribute {
5275
5953
  /**
5276
5954
  * ID for the entity attribute
5277
5955
  * example:
@@ -5402,12 +6080,17 @@ declare namespace Components {
5402
6080
  */
5403
6081
  hint_tooltip_placement?: string;
5404
6082
  };
5405
- type?: "partner_organisation";
6083
+ /**
6084
+ * The attribute is a repeatable
6085
+ */
6086
+ repeatable?: boolean;
6087
+ has_primary?: boolean;
6088
+ type?: "relation_payment_method";
5406
6089
  }
5407
6090
  /**
5408
- * Partner Status
6091
+ * Phone number
5409
6092
  */
5410
- export interface PartnerStatusAttribute {
6093
+ export interface PhoneAttribute {
5411
6094
  /**
5412
6095
  * ID for the entity attribute
5413
6096
  * example:
@@ -5538,12 +6221,17 @@ declare namespace Components {
5538
6221
  */
5539
6222
  hint_tooltip_placement?: string;
5540
6223
  };
5541
- type?: "partner_status";
6224
+ /**
6225
+ * The attribute is a repeatable
6226
+ */
6227
+ repeatable?: boolean;
6228
+ has_primary?: boolean;
6229
+ type?: "phone";
5542
6230
  }
5543
6231
  /**
5544
- * Reference to a payment method attribute of another entity
6232
+ * Price component
5545
6233
  */
5546
- export interface PaymentMethodRelationAttribute {
6234
+ export interface PriceComponentAttribute {
5547
6235
  /**
5548
6236
  * ID for the entity attribute
5549
6237
  * example:
@@ -5674,8 +6362,12 @@ declare namespace Components {
5674
6362
  */
5675
6363
  hint_tooltip_placement?: string;
5676
6364
  };
5677
- type?: "relation_payment_method";
6365
+ /**
6366
+ * The attribute is a repeatable
6367
+ */
6368
+ repeatable?: boolean;
5678
6369
  has_primary?: boolean;
6370
+ type?: "price_component";
5679
6371
  }
5680
6372
  /**
5681
6373
  * Entity Taxonomy
@@ -5819,6 +6511,11 @@ declare namespace Components {
5819
6511
  */
5820
6512
  hint_tooltip_placement?: string;
5821
6513
  };
6514
+ /**
6515
+ * The attribute is a repeatable
6516
+ */
6517
+ repeatable?: boolean;
6518
+ has_primary?: boolean;
5822
6519
  /**
5823
6520
  * URL-friendly identifier for the classification
5824
6521
  * example:
@@ -5993,6 +6690,11 @@ declare namespace Components {
5993
6690
  */
5994
6691
  hint_tooltip_placement?: string;
5995
6692
  };
6693
+ /**
6694
+ * Relations are always repeatables
6695
+ */
6696
+ repeatable?: boolean;
6697
+ has_primary?: boolean;
5996
6698
  type?: "relation";
5997
6699
  relation_type?: "has_many" | "has_one";
5998
6700
  /**
@@ -6019,6 +6721,16 @@ declare namespace Components {
6019
6721
  * Enables the preview, edition, and creation of relation items on a Master-Details view mode.
6020
6722
  */
6021
6723
  details_view_mode_enabled?: boolean;
6724
+ /**
6725
+ * Additional entity search filter for relation picker
6726
+ */
6727
+ relation_picker_filter?: {
6728
+ /**
6729
+ * example:
6730
+ * AND is_composite_price:true
6731
+ */
6732
+ q: string;
6733
+ };
6022
6734
  /**
6023
6735
  * example:
6024
6736
  * {
@@ -6068,90 +6780,18 @@ declare namespace Components {
6068
6780
  */
6069
6781
  settings_flag?: SettingFlag[];
6070
6782
  /**
6783
+ * Default field values for new entity to create
6071
6784
  * example:
6072
6785
  * {
6073
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6074
- * "_org": "123",
6075
- * "_owners": [
6076
- * {
6077
- * "org_id": "123",
6078
- * "user_id": "123"
6079
- * },
6080
- * {
6081
- * "org_id": "123",
6082
- * "user_id": "123"
6083
- * }
6084
- * ],
6085
- * "_schema": "contact",
6086
- * "_tags": [
6087
- * "example",
6088
- * "mock",
6089
- * "example",
6090
- * "mock"
6091
- * ],
6092
- * "_created_at": "2021-02-09T12:41:43.662Z",
6093
- * "_updated_at": "2021-02-09T12:41:43.662Z",
6094
- * "_acl": {
6095
- * "view": [
6096
- * "org:456",
6097
- * "org:789",
6098
- * "org:456",
6099
- * "org:789"
6100
- * ],
6101
- * "edit": [
6102
- * "org:456",
6103
- * "org:456"
6104
- * ],
6105
- * "delete": [
6106
- * "org:456",
6107
- * "org:456"
6108
- * ]
6109
- * },
6110
- * "_manifest": [
6111
- * "123e4567-e89b-12d3-a456-426614174000",
6112
- * "123e4567-e89b-12d3-a456-426614174000"
6113
- * ]
6786
+ * "_schema": "order"
6114
6787
  * }
6115
6788
  */
6116
6789
  new_entity_item?: {
6117
6790
  [name: string]: any;
6118
- _id: EntityId /* uuid */;
6119
- /**
6120
- * Organization Id the entity belongs to
6121
- */
6122
- _org: string;
6123
- _owners?: /**
6124
- * The user / organization owning this entity.
6125
- *
6126
- * Note: Owner implicitly has access to the entity regardless of ACLs.
6127
- *
6128
- */
6129
- EntityOwner[];
6130
- _schema: /**
6131
- * URL-friendly identifier for the entity schema
6132
- * example:
6133
- * contact
6134
- */
6135
- EntitySlug;
6136
- /**
6137
- * Title of entity
6138
- */
6139
- _title: string | null;
6140
- _tags?: string[] | null;
6141
- _created_at: string | null; // date-time
6142
- _updated_at: string | null; // date-time
6143
- _deleted_at?: string | null; // date-time
6144
- _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
6145
- _purpose?: string[] | null;
6146
- /**
6147
- * Manifest ID used to create/update the entity
6148
- */
6149
- _manifest?: string /* uuid */[] | null;
6150
- };
6791
+ } | null;
6151
6792
  }[];
6152
6793
  drawer_size?: "small" | "medium" | "large";
6153
6794
  summary_fields?: (string | /* Summary Fields are displayed inside list view as a resume of the relation entity. */ SummaryField)[];
6154
- has_primary?: boolean;
6155
6795
  allowedSchemas?: /**
6156
6796
  * URL-friendly identifier for the entity schema
6157
6797
  * example:
@@ -6389,17 +7029,11 @@ declare namespace Components {
6389
7029
  */
6390
7030
  hint_tooltip_placement?: string;
6391
7031
  };
6392
- repeatable?: boolean;
6393
- has_primary?: boolean;
6394
- /**
6395
- * Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.
6396
- */
6397
- relation_affinity_mode?: "weak" | "strong";
6398
- type?: "string" | "phone" | "email" | "address" | "relation" | "payment" | "price_component" | "date" | "message_email_address";
6399
7032
  /**
6400
- * when enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.
7033
+ * The attribute is a repeatable
6401
7034
  */
6402
- enable_relation_picker?: boolean;
7035
+ repeatable?: boolean;
7036
+ has_primary?: boolean;
6403
7037
  }
6404
7038
  /**
6405
7039
  * A saved entity view
@@ -6936,6 +7570,11 @@ declare namespace Components {
6936
7570
  */
6937
7571
  hint_tooltip_placement?: string;
6938
7572
  };
7573
+ /**
7574
+ * The attribute is a repeatable
7575
+ */
7576
+ repeatable?: boolean;
7577
+ has_primary?: boolean;
6939
7578
  type?: "select" | "radio";
6940
7579
  options?: ({
6941
7580
  value: string;
@@ -7080,6 +7719,11 @@ declare namespace Components {
7080
7719
  */
7081
7720
  hint_tooltip_placement?: string;
7082
7721
  };
7722
+ /**
7723
+ * The attribute is a repeatable
7724
+ */
7725
+ repeatable?: boolean;
7726
+ has_primary?: boolean;
7083
7727
  type?: "sequence";
7084
7728
  /**
7085
7729
  * Prefix added before the sequence number
@@ -7233,6 +7877,11 @@ declare namespace Components {
7233
7877
  */
7234
7878
  hint_tooltip_placement?: string;
7235
7879
  };
7880
+ /**
7881
+ * The attribute is a repeatable
7882
+ */
7883
+ repeatable?: boolean;
7884
+ has_primary?: boolean;
7236
7885
  type?: "status";
7237
7886
  options?: ((string | null) | {
7238
7887
  /**
@@ -7465,6 +8114,11 @@ declare namespace Components {
7465
8114
  */
7466
8115
  hint_tooltip_placement?: string;
7467
8116
  };
8117
+ /**
8118
+ * The attribute is a repeatable
8119
+ */
8120
+ repeatable?: boolean;
8121
+ has_primary?: boolean;
7468
8122
  type?: "tags";
7469
8123
  options?: string[];
7470
8124
  suggestions?: string[];
@@ -7551,6 +8205,7 @@ declare namespace Components {
7551
8205
  export interface TaxonomyBulkJob {
7552
8206
  job_id?: string; // uuid
7553
8207
  job_status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
8208
+ failure_reason?: string;
7554
8209
  action_type?: TaxonomyBulkJobActionType;
7555
8210
  request?: {
7556
8211
  target_taxonomy?: /**
@@ -7559,6 +8214,11 @@ declare namespace Components {
7559
8214
  * purpose
7560
8215
  */
7561
8216
  TaxonomySlug;
8217
+ target_classification?: /**
8218
+ * example:
8219
+ * taxonomy-slug:classification-slug
8220
+ */
8221
+ ClassificationId;
7562
8222
  classification_ids?: /**
7563
8223
  * example:
7564
8224
  * taxonomy-slug:classification-slug
@@ -7580,7 +8240,7 @@ declare namespace Components {
7580
8240
  */
7581
8241
  progress?: number;
7582
8242
  }
7583
- export type TaxonomyBulkJobActionType = "MOVE_CLASSIFICATIONS" | "DELETE_CLASSIFICATIONS";
8243
+ export type TaxonomyBulkJobActionType = "MOVE_CLASSIFICATIONS" | "MERGE_CLASSIFICATIONS" | "DELETE_CLASSIFICATIONS";
7584
8244
  /**
7585
8245
  * The status of the bulk job
7586
8246
  */
@@ -7629,6 +8289,16 @@ declare namespace Components {
7629
8289
  _manifest?: string /* uuid */[] | null;
7630
8290
  }
7631
8291
  export type TaxonomyLocationId = "account" | "contact" | "contract" | "email_template" | "file" | "journey" | "meter_counter" | "meter" | "opportunity" | "order" | "partner" | "price" | "product" | "submission" | "tax" | "message" | "portal_user" | "request" | "comment";
8292
+ /**
8293
+ * Whether to include archived labels in the search results
8294
+ * - `true`: include archived labels
8295
+ * - `false`: exclude archived labels
8296
+ * - `only`: include only archived labels
8297
+ *
8298
+ * By default, no archived labels are included in the search results.
8299
+ *
8300
+ */
8301
+ export type TaxonomySearchIncludeArchivedParam = "true" | "false" | "only";
7632
8302
  /**
7633
8303
  * URL-friendly name for taxonomy
7634
8304
  * example:
@@ -7769,9 +8439,25 @@ declare namespace Components {
7769
8439
  */
7770
8440
  hint_tooltip_placement?: string;
7771
8441
  };
8442
+ /**
8443
+ * The attribute is a repeatable
8444
+ */
8445
+ repeatable?: boolean;
8446
+ has_primary?: boolean;
7772
8447
  type?: "string";
7773
8448
  multiline?: boolean;
7774
8449
  rich_text?: boolean;
8450
+ /**
8451
+ * Number of rows for rich_text textarea
8452
+ * example:
8453
+ * 3
8454
+ */
8455
+ rows?: /**
8456
+ * Number of rows for rich_text textarea
8457
+ * example:
8458
+ * 3
8459
+ */
8460
+ number | string;
7775
8461
  }
7776
8462
  /**
7777
8463
  * User Relationship
@@ -7907,6 +8593,11 @@ declare namespace Components {
7907
8593
  */
7908
8594
  hint_tooltip_placement?: string;
7909
8595
  };
8596
+ /**
8597
+ * The attribute is a repeatable
8598
+ */
8599
+ repeatable?: boolean;
8600
+ has_primary?: boolean;
7910
8601
  type?: "relation_user";
7911
8602
  multiple?: boolean;
7912
8603
  }
@@ -8042,6 +8733,31 @@ declare namespace Paths {
8042
8733
  export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
8043
8734
  }
8044
8735
  }
8736
+ namespace BulkMergeClassifications {
8737
+ export interface RequestBody {
8738
+ /**
8739
+ * Job ID for tracking the status of a bulk operation request
8740
+ */
8741
+ job_id?: string;
8742
+ /**
8743
+ * The target classification id to which the classifications will be merged into
8744
+ */
8745
+ target_classification?: /**
8746
+ * URL-friendly name for taxonomy
8747
+ * example:
8748
+ * purpose
8749
+ */
8750
+ Components.Schemas.TaxonomySlug;
8751
+ classification_ids?: /**
8752
+ * example:
8753
+ * taxonomy-slug:classification-slug
8754
+ */
8755
+ Components.Schemas.ClassificationId[];
8756
+ }
8757
+ namespace Responses {
8758
+ export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
8759
+ }
8760
+ }
8045
8761
  namespace BulkMoveClassifications {
8046
8762
  export interface RequestBody {
8047
8763
  /**
@@ -10098,6 +10814,16 @@ declare namespace Paths {
10098
10814
  * false
10099
10815
  */
10100
10816
  export type Archived = boolean;
10817
+ export type IncludeArchived = /**
10818
+ * Whether to include archived labels in the search results
10819
+ * - `true`: include archived labels
10820
+ * - `false`: exclude archived labels
10821
+ * - `only`: include only archived labels
10822
+ *
10823
+ * By default, no archived labels are included in the search results.
10824
+ *
10825
+ */
10826
+ Components.Schemas.TaxonomySearchIncludeArchivedParam;
10101
10827
  /**
10102
10828
  * example:
10103
10829
  * sales
@@ -10117,6 +10843,7 @@ declare namespace Paths {
10117
10843
  * false
10118
10844
  */
10119
10845
  Parameters.Archived;
10846
+ include_archived?: Parameters.IncludeArchived;
10120
10847
  }
10121
10848
  export interface RequestBody {
10122
10849
  classificationIds?: /**
@@ -11512,6 +12239,18 @@ export interface OperationMethods {
11512
12239
  data?: Paths.BulkMoveClassifications.RequestBody,
11513
12240
  config?: AxiosRequestConfig
11514
12241
  ): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
12242
+ /**
12243
+ * bulkMergeClassifications - bulkMergeClassifications
12244
+ *
12245
+ * Merges classifications from one taxonomy into one individual classification, through a bulk async operation which
12246
+ * also updates all references from the old Classifications to the new one.
12247
+ *
12248
+ */
12249
+ 'bulkMergeClassifications'(
12250
+ parameters?: Parameters<UnknownParamsObject> | null,
12251
+ data?: Paths.BulkMergeClassifications.RequestBody,
12252
+ config?: AxiosRequestConfig
12253
+ ): OperationResponse<Paths.BulkMergeClassifications.Responses.$200>
11515
12254
  /**
11516
12255
  * bulkDeleteClassifications - bulkDeleteClassifications
11517
12256
  *
@@ -12609,6 +13348,20 @@ export interface PathsDictionary {
12609
13348
  config?: AxiosRequestConfig
12610
13349
  ): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
12611
13350
  }
13351
+ ['/v1/entity/taxonomies/classifications:merge']: {
13352
+ /**
13353
+ * bulkMergeClassifications - bulkMergeClassifications
13354
+ *
13355
+ * Merges classifications from one taxonomy into one individual classification, through a bulk async operation which
13356
+ * also updates all references from the old Classifications to the new one.
13357
+ *
13358
+ */
13359
+ 'post'(
13360
+ parameters?: Parameters<UnknownParamsObject> | null,
13361
+ data?: Paths.BulkMergeClassifications.RequestBody,
13362
+ config?: AxiosRequestConfig
13363
+ ): OperationResponse<Paths.BulkMergeClassifications.Responses.$200>
13364
+ }
12612
13365
  ['/v1/entity/taxonomies/classifications:delete']: {
12613
13366
  /**
12614
13367
  * bulkDeleteClassifications - bulkDeleteClassifications
@@ -12828,6 +13581,7 @@ export type CurrencyAttribute = Components.Schemas.CurrencyAttribute;
12828
13581
  export type DateAttribute = Components.Schemas.DateAttribute;
12829
13582
  export type DefaultAddressFields = Components.Schemas.DefaultAddressFields;
12830
13583
  export type ESClusterAssignment = Components.Schemas.ESClusterAssignment;
13584
+ export type EmailAttribute = Components.Schemas.EmailAttribute;
12831
13585
  export type Entity = Components.Schemas.Entity;
12832
13586
  export type EntityAcl = Components.Schemas.EntityAcl;
12833
13587
  export type EntityAction = Components.Schemas.EntityAction;
@@ -12888,7 +13642,10 @@ export type NumberAttribute = Components.Schemas.NumberAttribute;
12888
13642
  export type OrderedListAttribute = Components.Schemas.OrderedListAttribute;
12889
13643
  export type PartnerOrganisationAttribute = Components.Schemas.PartnerOrganisationAttribute;
12890
13644
  export type PartnerStatusAttribute = Components.Schemas.PartnerStatusAttribute;
13645
+ export type PaymentAttribute = Components.Schemas.PaymentAttribute;
12891
13646
  export type PaymentMethodRelationAttribute = Components.Schemas.PaymentMethodRelationAttribute;
13647
+ export type PhoneAttribute = Components.Schemas.PhoneAttribute;
13648
+ export type PriceComponentAttribute = Components.Schemas.PriceComponentAttribute;
12892
13649
  export type PurposeAttribute = Components.Schemas.PurposeAttribute;
12893
13650
  export type RedirectEntityView = Components.Schemas.RedirectEntityView;
12894
13651
  export type RelationAttribute = Components.Schemas.RelationAttribute;
@@ -12917,6 +13674,7 @@ export type TaxonomyBulkJobStatus = Components.Schemas.TaxonomyBulkJobStatus;
12917
13674
  export type TaxonomyBulkJobTriggerResponse = Components.Schemas.TaxonomyBulkJobTriggerResponse;
12918
13675
  export type TaxonomyClassification = Components.Schemas.TaxonomyClassification;
12919
13676
  export type TaxonomyLocationId = Components.Schemas.TaxonomyLocationId;
13677
+ export type TaxonomySearchIncludeArchivedParam = Components.Schemas.TaxonomySearchIncludeArchivedParam;
12920
13678
  export type TaxonomySlug = Components.Schemas.TaxonomySlug;
12921
13679
  export type TextAttribute = Components.Schemas.TextAttribute;
12922
13680
  export type UserRelationAttribute = Components.Schemas.UserRelationAttribute;