@epilot/entity-client 4.34.1 → 4.34.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/openapi.d.ts CHANGED
@@ -92,6 +92,30 @@ declare namespace Components {
92
92
  FillActivityQueryParam?: Parameters.FillActivityQueryParam;
93
93
  ValidateEntityQueryParam?: Parameters.ValidateEntityQueryParam;
94
94
  }
95
+ namespace Responses {
96
+ /**
97
+ * A generic error returned by the API
98
+ * example:
99
+ * {
100
+ * "status": 404,
101
+ * "error": "Not Found"
102
+ * }
103
+ */
104
+ export interface NotFoundError {
105
+ /**
106
+ * The HTTP status code of the error
107
+ * example:
108
+ * 400
109
+ */
110
+ status?: number;
111
+ /**
112
+ * The error message
113
+ * example:
114
+ * Bad Request
115
+ */
116
+ error?: string;
117
+ }
118
+ }
95
119
  namespace Schemas {
96
120
  export interface Activity {
97
121
  /**
@@ -374,10 +398,7 @@ declare namespace Components {
374
398
  hint_tooltip_placement?: string;
375
399
  };
376
400
  type?: "address";
377
- /**
378
- * Default fields visible on addresses
379
- */
380
- default_address_fields?: ("postal_code" | "city" | "street" | "street_number" | "plot_area" | "plot_of_land" | "suburb" | "country" | "additional_info" | "coordinates" | "start_date" | "end_date" | "salutation" | "title" | "first_name" | "last_name" | "company_name")[];
401
+ default_address_fields?: /* Default fields visible on addresses */ DefaultAddressFields;
381
402
  }
382
403
  /**
383
404
  * Reference to an address attribute of another entity
@@ -515,8 +536,9 @@ declare namespace Components {
515
536
  };
516
537
  type?: "relation_address";
517
538
  has_primary?: boolean;
539
+ default_address_fields?: /* Default fields visible on addresses */ DefaultAddressFields;
518
540
  }
519
- 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 | /* 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;
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;
520
542
  /**
521
543
  * a readonly computed ID for the attribute including schema slug and the attribute ID
522
544
  */
@@ -532,7 +554,7 @@ declare namespace Components {
532
554
  * contact
533
555
  */
534
556
  schema?: string;
535
- } & (/* 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 | /* 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);
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);
536
558
  /**
537
559
  * Automation entity
538
560
  */
@@ -1768,6 +1790,10 @@ declare namespace Components {
1768
1790
  };
1769
1791
  type?: "date" | "datetime";
1770
1792
  }
1793
+ /**
1794
+ * Default fields visible on addresses
1795
+ */
1796
+ export type DefaultAddressFields = ("postal_code" | "city" | "street" | "street_number" | "plot_area" | "plot_of_land" | "suburb" | "country" | "additional_info" | "coordinates" | "start_date" | "end_date" | "salutation" | "title" | "first_name" | "last_name" | "company_name")[];
1771
1797
  export interface ESClusterAssignment {
1772
1798
  /**
1773
1799
  * The organization for which the cluster assignment is returned
@@ -2636,7 +2662,7 @@ declare namespace Components {
2636
2662
  * example:
2637
2663
  * customer_relations
2638
2664
  */
2639
- category?: "customer_relations" | "sales" | "product_hub" | "contracts" | "journeys" | "messaging" | "system";
2665
+ category?: string;
2640
2666
  /**
2641
2667
  * example:
2642
2668
  * false
@@ -2708,6 +2734,12 @@ declare namespace Components {
2708
2734
  */
2709
2735
  SummaryAttribute | string)[];
2710
2736
  quick_actions?: /* An entity action configured from the entity schema */ EntityAction[];
2737
+ ui_config?: {
2738
+ /**
2739
+ * Show attributes in a row or column
2740
+ */
2741
+ content_direction?: "row" | "column";
2742
+ };
2711
2743
  };
2712
2744
  sharing?: {
2713
2745
  /**
@@ -3010,7 +3042,7 @@ declare namespace Components {
3010
3042
  * example:
3011
3043
  * customer_relations
3012
3044
  */
3013
- category?: "customer_relations" | "sales" | "product_hub" | "contracts" | "journeys" | "messaging" | "system";
3045
+ category?: string;
3014
3046
  /**
3015
3047
  * example:
3016
3048
  * false
@@ -3082,6 +3114,12 @@ declare namespace Components {
3082
3114
  */
3083
3115
  SummaryAttribute | string)[];
3084
3116
  quick_actions?: /* An entity action configured from the entity schema */ EntityAction[];
3117
+ ui_config?: {
3118
+ /**
3119
+ * Show attributes in a row or column
3120
+ */
3121
+ content_direction?: "row" | "column";
3122
+ };
3085
3123
  };
3086
3124
  sharing?: {
3087
3125
  /**
@@ -3579,6 +3617,23 @@ declare namespace Components {
3579
3617
  export interface EntityViewDisabled {
3580
3618
  view_type?: "disabled";
3581
3619
  }
3620
+ /**
3621
+ * A generic error returned by the API
3622
+ */
3623
+ export interface ErrorObject {
3624
+ /**
3625
+ * The HTTP status code of the error
3626
+ * example:
3627
+ * 400
3628
+ */
3629
+ status?: number;
3630
+ /**
3631
+ * The error message
3632
+ * example:
3633
+ * Bad Request
3634
+ */
3635
+ error?: string;
3636
+ }
3582
3637
  /**
3583
3638
  * The unique identifier of the import job.
3584
3639
  * example:
@@ -4644,6 +4699,145 @@ declare namespace Components {
4644
4699
  hits?: number;
4645
4700
  results?: /* A saved entity view */ SavedViewItem[];
4646
4701
  }
4702
+ /**
4703
+ * Message emil address
4704
+ */
4705
+ export interface MessageEmailAddressAttribute {
4706
+ /**
4707
+ * ID for the entity attribute
4708
+ * example:
4709
+ * d5839b94-ba20-4225-a78e-76951d352bd6
4710
+ */
4711
+ id?: string;
4712
+ name: string;
4713
+ label: string;
4714
+ placeholder?: string;
4715
+ /**
4716
+ * Do not render attribute in entity views
4717
+ */
4718
+ hidden?: boolean;
4719
+ /**
4720
+ * Render as a column in table views. When defined, overrides `hidden`
4721
+ */
4722
+ show_in_table?: boolean;
4723
+ /**
4724
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4725
+ */
4726
+ sortable?: boolean;
4727
+ required?: boolean;
4728
+ readonly?: boolean;
4729
+ deprecated?: boolean;
4730
+ default_value?: any;
4731
+ /**
4732
+ * Which group the attribute should appear in. Accepts group ID or group name
4733
+ */
4734
+ group?: string;
4735
+ /**
4736
+ * Attribute sort order (ascending) in group
4737
+ * example:
4738
+ * 0
4739
+ */
4740
+ order?: number;
4741
+ /**
4742
+ * example:
4743
+ * full_width
4744
+ */
4745
+ layout?: string;
4746
+ /**
4747
+ * When set to true, will hide the label of the field.
4748
+ */
4749
+ hide_label?: boolean;
4750
+ /**
4751
+ * Code name of the icon to used to represent this attribute.
4752
+ * The value must be a valid @epilot/base-elements Icon name
4753
+ *
4754
+ */
4755
+ icon?: string;
4756
+ /**
4757
+ * Defines the conditional rendering expression for showing this field.
4758
+ * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
4759
+ * Note: Empty or invalid expression have no effect on the field visibility.
4760
+ *
4761
+ */
4762
+ render_condition?: string;
4763
+ _purpose?: /**
4764
+ * example:
4765
+ * taxonomy-slug:classification-slug
4766
+ */
4767
+ ClassificationId[];
4768
+ /**
4769
+ * Manifest ID used to create/update the schema attribute
4770
+ */
4771
+ _manifest?: string /* uuid */[] | null;
4772
+ /**
4773
+ * A set of constraints applicable to the attribute.
4774
+ * These constraints should and will be enforced by the attribute renderer.
4775
+ *
4776
+ * example:
4777
+ * {
4778
+ * "disablePast": true
4779
+ * }
4780
+ */
4781
+ constraints?: {
4782
+ [key: string]: any;
4783
+ };
4784
+ /**
4785
+ * This attribute should only be active when the feature flag is enabled
4786
+ * example:
4787
+ * FF_MY_FEATURE_FLAG
4788
+ */
4789
+ feature_flag?: string;
4790
+ /**
4791
+ * This attribute should only be active when one of the provided settings have the correct value
4792
+ */
4793
+ settings_flag?: SettingFlag[];
4794
+ value_formatter?: string;
4795
+ preview_value_formatter?: string;
4796
+ /**
4797
+ * Setting to `true` disables editing the attribute on the entity builder UI
4798
+ */
4799
+ entity_builder_disable_edit?: boolean;
4800
+ /**
4801
+ * Setting to `true` prevents the attribute from being modified / deleted
4802
+ */
4803
+ protected?: boolean;
4804
+ /**
4805
+ * A set of configurations meant to document and assist the user in filling the attribute.
4806
+ */
4807
+ info_helpers?: {
4808
+ /**
4809
+ * The text to be displayed in the attribute hint helper.
4810
+ * When specified it overrides the `hint_text_key` configuration.
4811
+ *
4812
+ */
4813
+ hint_text?: string;
4814
+ /**
4815
+ * The key of the hint text to be displayed in the attribute hint helper.
4816
+ * The key should be a valid i18n key.
4817
+ *
4818
+ */
4819
+ hint_text_key?: string;
4820
+ /**
4821
+ * The name of the custom component to be used as the hint helper.
4822
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
4823
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
4824
+ *
4825
+ */
4826
+ hint_custom_component?: string;
4827
+ /**
4828
+ * The placement of the hint tooltip.
4829
+ * The value should be a valid `@mui/core` tooltip placement.
4830
+ *
4831
+ * example:
4832
+ * top
4833
+ */
4834
+ hint_tooltip_placement?: string;
4835
+ };
4836
+ type: "message_email_address";
4837
+ address: string;
4838
+ send_status?: string;
4839
+ email_type?: string;
4840
+ }
4647
4841
  /**
4648
4842
  * Multi Choice Selection
4649
4843
  */
@@ -6049,6 +6243,10 @@ declare namespace Components {
6049
6243
  }
6050
6244
  export interface RelationItem {
6051
6245
  entity_id: EntityId /* uuid */;
6246
+ /**
6247
+ * Organization Id the entity belongs to
6248
+ */
6249
+ org_id?: string;
6052
6250
  attribute: string;
6053
6251
  _tags?: string[];
6054
6252
  /**
@@ -6196,7 +6394,7 @@ declare namespace Components {
6196
6394
  * Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.
6197
6395
  */
6198
6396
  relation_affinity_mode?: "weak" | "strong";
6199
- type?: "string" | "phone" | "email" | "address" | "relation" | "payment" | "price_component" | "date";
6397
+ type?: "string" | "phone" | "email" | "address" | "relation" | "payment" | "price_component" | "date" | "message_email_address";
6200
6398
  /**
6201
6399
  * 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.
6202
6400
  */
@@ -6267,6 +6465,10 @@ declare namespace Components {
6267
6465
  ui_config: {
6268
6466
  [name: string]: any;
6269
6467
  };
6468
+ /**
6469
+ * List of users ('${userId}'), user groups ('group_${groupId}'), or partner users ('${partnerOrgId}_${partnerUserId}') that the view is shared with
6470
+ */
6471
+ shared_with?: string[];
6270
6472
  }
6271
6473
  /**
6272
6474
  * Generated uuid for a saved view
@@ -6340,6 +6542,80 @@ declare namespace Components {
6340
6542
  ui_config: {
6341
6543
  [name: string]: any;
6342
6544
  };
6545
+ /**
6546
+ * List of users ('${userId}'), user groups ('group_${groupId}'), or partner users ('${partnerOrgId}_${partnerUserId}') that the view is shared with
6547
+ */
6548
+ shared_with?: string[];
6549
+ }
6550
+ /**
6551
+ * A saved entity view
6552
+ */
6553
+ export interface SavedViewPartial {
6554
+ /**
6555
+ * list of schemas a view can belong to
6556
+ */
6557
+ slug?: /**
6558
+ * URL-friendly identifier for the entity schema
6559
+ * example:
6560
+ * contact
6561
+ */
6562
+ EntitySlug[];
6563
+ /**
6564
+ * User-friendly identifier for the saved view
6565
+ * example:
6566
+ * View listing German
6567
+ */
6568
+ name?: string;
6569
+ /**
6570
+ * Organisation ID a view belongs to
6571
+ * example:
6572
+ * 66
6573
+ */
6574
+ org?: string;
6575
+ /**
6576
+ * boolean property for if a view is shared with organisation
6577
+ * example:
6578
+ * true
6579
+ */
6580
+ shared?: boolean;
6581
+ /**
6582
+ * List of users (IDs) that have favorited the view
6583
+ */
6584
+ isFavoritedBy?: string[];
6585
+ created_by?: {
6586
+ /**
6587
+ * example:
6588
+ * 10598
6589
+ */
6590
+ user_id?: string;
6591
+ } | {
6592
+ [name: string]: any;
6593
+ source?: "SYSTEM" | "BLUEPRINT";
6594
+ };
6595
+ /**
6596
+ * example:
6597
+ * {
6598
+ * "filters": {
6599
+ * "customer_name": "suresh test",
6600
+ * "_tags": "360"
6601
+ * },
6602
+ * "table_layout": {
6603
+ * "opportunity": {
6604
+ * "page": 1,
6605
+ * "sort": "_created_at:desc",
6606
+ * "pageSize": 25,
6607
+ * "columnSettings": []
6608
+ * }
6609
+ * }
6610
+ * }
6611
+ */
6612
+ ui_config?: {
6613
+ [name: string]: any;
6614
+ };
6615
+ /**
6616
+ * List of users ('${userId}'), user groups ('group_${groupId}'), or partner users ('${partnerOrgId}_${partnerUserId}') that the view is shared with
6617
+ */
6618
+ shared_with?: string[];
6343
6619
  }
6344
6620
  /**
6345
6621
  * Generated uuid for schema
@@ -7014,6 +7290,32 @@ declare namespace Components {
7014
7290
  * This summary attribute should only be visible when all the settings have the correct value
7015
7291
  */
7016
7292
  settings_flag?: SettingFlag[];
7293
+ /**
7294
+ * Defines the display mode of the summary attribute.
7295
+ * When set to `inline`, the label and value will be displayed in the same line.
7296
+ * When set to `block`, the label and value will be displayed in separate lines.
7297
+ *
7298
+ */
7299
+ display_mode?: "inline" | "block";
7300
+ /**
7301
+ * Defines the line numbers of the content.
7302
+ * For instance, When set to 1, the content will be displayed in a single line.
7303
+ *
7304
+ */
7305
+ content_line_cap?: number;
7306
+ /**
7307
+ * Defines white-space of the content.
7308
+ *
7309
+ */
7310
+ content_wrap?: "normal" | "nowrap" | "pre" | "pre-wrap";
7311
+ /**
7312
+ * When set to true, will hide the label of the field.
7313
+ */
7314
+ hide_label?: boolean;
7315
+ /**
7316
+ * When set to true, will highlight the container of the field.
7317
+ */
7318
+ highlight_container?: boolean;
7017
7319
  }
7018
7320
  /**
7019
7321
  * Summary Fields are displayed inside list view as a resume of the relation entity.
@@ -7638,6 +7940,15 @@ declare namespace Paths {
7638
7940
  export type RequestBody = Components.Schemas.RelationItem[];
7639
7941
  namespace Responses {
7640
7942
  export type $200 = Components.Schemas.RelationItem;
7943
+ export type $404 = /**
7944
+ * A generic error returned by the API
7945
+ * example:
7946
+ * {
7947
+ * "status": 404,
7948
+ * "error": "Not Found"
7949
+ * }
7950
+ */
7951
+ Components.Responses.NotFoundError;
7641
7952
  }
7642
7953
  }
7643
7954
  namespace AttachActivity {
@@ -7658,6 +7969,15 @@ declare namespace Paths {
7658
7969
  }
7659
7970
  namespace Responses {
7660
7971
  export type $200 = Components.Schemas.BaseActivityItem;
7972
+ export type $404 = /**
7973
+ * A generic error returned by the API
7974
+ * example:
7975
+ * {
7976
+ * "status": 404,
7977
+ * "error": "Not Found"
7978
+ * }
7979
+ */
7980
+ Components.Responses.NotFoundError;
7661
7981
  }
7662
7982
  }
7663
7983
  namespace Autocomplete {
@@ -7972,6 +8292,15 @@ declare namespace Paths {
7972
8292
  namespace Responses {
7973
8293
  export interface $204 {
7974
8294
  }
8295
+ export type $404 = /**
8296
+ * A generic error returned by the API
8297
+ * example:
8298
+ * {
8299
+ * "status": 404,
8300
+ * "error": "Not Found"
8301
+ * }
8302
+ */
8303
+ Components.Responses.NotFoundError;
7975
8304
  }
7976
8305
  }
7977
8306
  namespace DeleteSavedView {
@@ -8148,6 +8477,15 @@ declare namespace Paths {
8148
8477
  }
8149
8478
  namespace Responses {
8150
8479
  export type $200 = Components.Schemas.ActivityItem;
8480
+ export type $404 = /**
8481
+ * A generic error returned by the API
8482
+ * example:
8483
+ * {
8484
+ * "status": 404,
8485
+ * "error": "Not Found"
8486
+ * }
8487
+ */
8488
+ Components.Responses.NotFoundError;
8151
8489
  }
8152
8490
  }
8153
8491
  namespace GetEntity {
@@ -8265,6 +8603,15 @@ declare namespace Paths {
8265
8603
  */
8266
8604
  Components.Schemas.EntityItem[];
8267
8605
  }
8606
+ export type $404 = /**
8607
+ * A generic error returned by the API
8608
+ * example:
8609
+ * {
8610
+ * "status": 404,
8611
+ * "error": "Not Found"
8612
+ * }
8613
+ */
8614
+ Components.Responses.NotFoundError;
8268
8615
  }
8269
8616
  }
8270
8617
  namespace GetEntityActivityFeed {
@@ -8312,6 +8659,15 @@ declare namespace Paths {
8312
8659
  total?: number;
8313
8660
  results?: Components.Schemas.ActivityItem[];
8314
8661
  }
8662
+ export type $404 = /**
8663
+ * A generic error returned by the API
8664
+ * example:
8665
+ * {
8666
+ * "status": 404,
8667
+ * "error": "Not Found"
8668
+ * }
8669
+ */
8670
+ Components.Responses.NotFoundError;
8315
8671
  }
8316
8672
  }
8317
8673
  namespace GetEntityV2 {
@@ -8399,6 +8755,15 @@ declare namespace Paths {
8399
8755
  * }
8400
8756
  */
8401
8757
  Components.Schemas.EntityItem;
8758
+ export type $404 = /**
8759
+ * A generic error returned by the API
8760
+ * example:
8761
+ * {
8762
+ * "status": 404,
8763
+ * "error": "Not Found"
8764
+ * }
8765
+ */
8766
+ Components.Responses.NotFoundError;
8402
8767
  }
8403
8768
  }
8404
8769
  namespace GetJsonSchema {
@@ -8742,6 +9107,15 @@ declare namespace Paths {
8742
9107
  }
8743
9108
  namespace Responses {
8744
9109
  export type $200 = Components.Schemas.GetRelatedEntitiesCount;
9110
+ export type $404 = /**
9111
+ * A generic error returned by the API
9112
+ * example:
9113
+ * {
9114
+ * "status": 404,
9115
+ * "error": "Not Found"
9116
+ * }
9117
+ */
9118
+ Components.Responses.NotFoundError;
8745
9119
  }
8746
9120
  }
8747
9121
  namespace GetRelations {
@@ -8784,6 +9158,15 @@ declare namespace Paths {
8784
9158
  }
8785
9159
  namespace Responses {
8786
9160
  export type $200 = Components.Schemas.GetRelationsResp;
9161
+ export type $404 = /**
9162
+ * A generic error returned by the API
9163
+ * example:
9164
+ * {
9165
+ * "status": 404,
9166
+ * "error": "Not Found"
9167
+ * }
9168
+ */
9169
+ Components.Responses.NotFoundError;
8787
9170
  }
8788
9171
  }
8789
9172
  namespace GetRelationsV2 {
@@ -8833,6 +9216,15 @@ declare namespace Paths {
8833
9216
  }
8834
9217
  namespace Responses {
8835
9218
  export type $200 = Components.Schemas.GetRelationsRespWithPagination;
9219
+ export type $404 = /**
9220
+ * A generic error returned by the API
9221
+ * example:
9222
+ * {
9223
+ * "status": 404,
9224
+ * "error": "Not Found"
9225
+ * }
9226
+ */
9227
+ Components.Responses.NotFoundError;
8836
9228
  }
8837
9229
  }
8838
9230
  namespace GetRelationsV3 {
@@ -8877,6 +9269,15 @@ declare namespace Paths {
8877
9269
  }
8878
9270
  namespace Responses {
8879
9271
  export type $200 = Components.Schemas.GetRelationsRespWithPagination;
9272
+ export type $404 = /**
9273
+ * A generic error returned by the API
9274
+ * example:
9275
+ * {
9276
+ * "status": 404,
9277
+ * "error": "Not Found"
9278
+ * }
9279
+ */
9280
+ Components.Responses.NotFoundError;
8880
9281
  }
8881
9282
  }
8882
9283
  namespace GetSavedView {
@@ -8888,6 +9289,15 @@ declare namespace Paths {
8888
9289
  }
8889
9290
  namespace Responses {
8890
9291
  export type $200 = /* A saved entity view */ Components.Schemas.SavedViewItem;
9292
+ export type $404 = /**
9293
+ * A generic error returned by the API
9294
+ * example:
9295
+ * {
9296
+ * "status": 404,
9297
+ * "error": "Not Found"
9298
+ * }
9299
+ */
9300
+ Components.Responses.NotFoundError;
8891
9301
  }
8892
9302
  }
8893
9303
  namespace GetSchema {
@@ -8908,6 +9318,15 @@ declare namespace Paths {
8908
9318
  }
8909
9319
  namespace Responses {
8910
9320
  export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
9321
+ export type $404 = /**
9322
+ * A generic error returned by the API
9323
+ * example:
9324
+ * {
9325
+ * "status": 404,
9326
+ * "error": "Not Found"
9327
+ * }
9328
+ */
9329
+ Components.Responses.NotFoundError;
8911
9330
  }
8912
9331
  }
8913
9332
  namespace GetSchemaAttribute {
@@ -8927,6 +9346,15 @@ declare namespace Paths {
8927
9346
  }
8928
9347
  namespace Responses {
8929
9348
  export type $200 = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
9349
+ export type $404 = /**
9350
+ * A generic error returned by the API
9351
+ * example:
9352
+ * {
9353
+ * "status": 404,
9354
+ * "error": "Not Found"
9355
+ * }
9356
+ */
9357
+ Components.Responses.NotFoundError;
8930
9358
  }
8931
9359
  }
8932
9360
  namespace GetSchemaCapability {
@@ -8946,6 +9374,15 @@ declare namespace Paths {
8946
9374
  }
8947
9375
  namespace Responses {
8948
9376
  export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
9377
+ export type $404 = /**
9378
+ * A generic error returned by the API
9379
+ * example:
9380
+ * {
9381
+ * "status": 404,
9382
+ * "error": "Not Found"
9383
+ * }
9384
+ */
9385
+ Components.Responses.NotFoundError;
8949
9386
  }
8950
9387
  }
8951
9388
  namespace GetSchemaExample {
@@ -8982,6 +9419,15 @@ declare namespace Paths {
8982
9419
  }
8983
9420
  namespace Responses {
8984
9421
  export type $200 = /* a readonly computed ID for the group including schema slug and the group ID */ Components.Schemas.EntitySchemaGroupWithCompositeID;
9422
+ export type $404 = /**
9423
+ * A generic error returned by the API
9424
+ * example:
9425
+ * {
9426
+ * "status": 404,
9427
+ * "error": "Not Found"
9428
+ * }
9429
+ */
9430
+ Components.Responses.NotFoundError;
8985
9431
  }
8986
9432
  }
8987
9433
  namespace GetSchemaGroupHeadline {
@@ -9001,6 +9447,15 @@ declare namespace Paths {
9001
9447
  }
9002
9448
  namespace Responses {
9003
9449
  export type $200 = /* a readonly computed ID for the entity group headline including schema slug and the headline ID */ Components.Schemas.GroupHeadlineWithCompositeID;
9450
+ export type $404 = /**
9451
+ * A generic error returned by the API
9452
+ * example:
9453
+ * {
9454
+ * "status": 404,
9455
+ * "error": "Not Found"
9456
+ * }
9457
+ */
9458
+ Components.Responses.NotFoundError;
9004
9459
  }
9005
9460
  }
9006
9461
  namespace GetSchemaVersions {
@@ -9059,6 +9514,15 @@ declare namespace Paths {
9059
9514
  }
9060
9515
  namespace Responses {
9061
9516
  export type $200 = Components.Schemas.Taxonomy;
9517
+ export type $404 = /**
9518
+ * A generic error returned by the API
9519
+ * example:
9520
+ * {
9521
+ * "status": 404,
9522
+ * "error": "Not Found"
9523
+ * }
9524
+ */
9525
+ Components.Responses.NotFoundError;
9062
9526
  }
9063
9527
  }
9064
9528
  namespace GetTaxonomyBulkActionJobById {
@@ -9118,8 +9582,15 @@ declare namespace Paths {
9118
9582
  }
9119
9583
  namespace Responses {
9120
9584
  export type $200 = Components.Schemas.TaxonomyClassification;
9121
- export interface $404 {
9122
- }
9585
+ export type $404 = /**
9586
+ * A generic error returned by the API
9587
+ * example:
9588
+ * {
9589
+ * "status": 404,
9590
+ * "error": "Not Found"
9591
+ * }
9592
+ */
9593
+ Components.Responses.NotFoundError;
9123
9594
  }
9124
9595
  }
9125
9596
  namespace ImportEntities {
@@ -9373,6 +9844,18 @@ declare namespace Paths {
9373
9844
  export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9374
9845
  }
9375
9846
  }
9847
+ namespace PatchSavedView {
9848
+ namespace Parameters {
9849
+ export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
9850
+ }
9851
+ export interface PathParameters {
9852
+ id: Parameters.Id;
9853
+ }
9854
+ export type RequestBody = /* A saved entity view */ Components.Schemas.SavedViewPartial;
9855
+ namespace Responses {
9856
+ export type $200 = /* A saved entity view */ Components.Schemas.SavedViewItem;
9857
+ }
9858
+ }
9376
9859
  namespace PutSchema {
9377
9860
  namespace Parameters {
9378
9861
  export type Draft = boolean;
@@ -9503,6 +9986,15 @@ declare namespace Paths {
9503
9986
  namespace Responses {
9504
9987
  export interface $204 {
9505
9988
  }
9989
+ export type $404 = /**
9990
+ * A generic error returned by the API
9991
+ * example:
9992
+ * {
9993
+ * "status": 404,
9994
+ * "error": "Not Found"
9995
+ * }
9996
+ */
9997
+ Components.Responses.NotFoundError;
9506
9998
  }
9507
9999
  }
9508
10000
  namespace RestoreEntity {
@@ -9668,6 +10160,15 @@ declare namespace Paths {
9668
10160
  [key: string]: any;
9669
10161
  };
9670
10162
  }
10163
+ export type $404 = /**
10164
+ * A generic error returned by the API
10165
+ * example:
10166
+ * {
10167
+ * "status": 404,
10168
+ * "error": "Not Found"
10169
+ * }
10170
+ */
10171
+ Components.Responses.NotFoundError;
9671
10172
  }
9672
10173
  }
9673
10174
  namespace UpdateEntity {
@@ -9820,6 +10321,15 @@ declare namespace Paths {
9820
10321
  }
9821
10322
  namespace Responses {
9822
10323
  export type $200 = Components.Schemas.RelationItem;
10324
+ export type $404 = /**
10325
+ * A generic error returned by the API
10326
+ * example:
10327
+ * {
10328
+ * "status": 404,
10329
+ * "error": "Not Found"
10330
+ * }
10331
+ */
10332
+ Components.Responses.NotFoundError;
9823
10333
  }
9824
10334
  }
9825
10335
  namespace UpdateSavedView {
@@ -10809,6 +11319,16 @@ export interface OperationMethods {
10809
11319
  data?: Paths.UpdateSavedView.RequestBody,
10810
11320
  config?: AxiosRequestConfig
10811
11321
  ): OperationResponse<Paths.UpdateSavedView.Responses.$200>
11322
+ /**
11323
+ * patchSavedView - patchSavedView
11324
+ *
11325
+ * Partially updates a saved view with the provided payload. If an updated_at is passed and the server contains a newer version of the view a `409` error is returned
11326
+ */
11327
+ 'patchSavedView'(
11328
+ parameters?: Parameters<Paths.PatchSavedView.PathParameters> | null,
11329
+ data?: Paths.PatchSavedView.RequestBody,
11330
+ config?: AxiosRequestConfig
11331
+ ): OperationResponse<Paths.PatchSavedView.Responses.$200>
10812
11332
  /**
10813
11333
  * deleteSavedView - deleteSavedView
10814
11334
  *
@@ -10989,8 +11509,8 @@ export interface OperationMethods {
10989
11509
  /**
10990
11510
  * bulkDeleteClassifications - bulkDeleteClassifications
10991
11511
  *
10992
- * Permanently deletes taxonomy classifications. The classifications are deleted through a bulk
10993
- * async operation which also deletes all references of the deleted classifications from the entities
11512
+ * Permanently deletes taxonomy classifications. The classifications are deleted through a bulk
11513
+ * async operation which also deletes all references of the deleted classifications from the entities
10994
11514
  * referencing them.
10995
11515
  *
10996
11516
  */
@@ -11873,6 +12393,16 @@ export interface PathsDictionary {
11873
12393
  data?: Paths.UpdateSavedView.RequestBody,
11874
12394
  config?: AxiosRequestConfig
11875
12395
  ): OperationResponse<Paths.UpdateSavedView.Responses.$200>
12396
+ /**
12397
+ * patchSavedView - patchSavedView
12398
+ *
12399
+ * Partially updates a saved view with the provided payload. If an updated_at is passed and the server contains a newer version of the view a `409` error is returned
12400
+ */
12401
+ 'patch'(
12402
+ parameters?: Parameters<Paths.PatchSavedView.PathParameters> | null,
12403
+ data?: Paths.PatchSavedView.RequestBody,
12404
+ config?: AxiosRequestConfig
12405
+ ): OperationResponse<Paths.PatchSavedView.Responses.$200>
11876
12406
  /**
11877
12407
  * deleteSavedView - deleteSavedView
11878
12408
  *
@@ -12077,8 +12607,8 @@ export interface PathsDictionary {
12077
12607
  /**
12078
12608
  * bulkDeleteClassifications - bulkDeleteClassifications
12079
12609
  *
12080
- * Permanently deletes taxonomy classifications. The classifications are deleted through a bulk
12081
- * async operation which also deletes all references of the deleted classifications from the entities
12610
+ * Permanently deletes taxonomy classifications. The classifications are deleted through a bulk
12611
+ * async operation which also deletes all references of the deleted classifications from the entities
12082
12612
  * referencing them.
12083
12613
  *
12084
12614
  */
@@ -12290,6 +12820,7 @@ export type ConsentAttribute = Components.Schemas.ConsentAttribute;
12290
12820
  export type CountryAttribute = Components.Schemas.CountryAttribute;
12291
12821
  export type CurrencyAttribute = Components.Schemas.CurrencyAttribute;
12292
12822
  export type DateAttribute = Components.Schemas.DateAttribute;
12823
+ export type DefaultAddressFields = Components.Schemas.DefaultAddressFields;
12293
12824
  export type ESClusterAssignment = Components.Schemas.ESClusterAssignment;
12294
12825
  export type Entity = Components.Schemas.Entity;
12295
12826
  export type EntityAcl = Components.Schemas.EntityAcl;
@@ -12325,6 +12856,7 @@ export type EntityValidationV2Result = Components.Schemas.EntityValidationV2Resu
12325
12856
  export type EntityValidationV2ResultError = Components.Schemas.EntityValidationV2ResultError;
12326
12857
  export type EntityValidationV2ResultSuccess = Components.Schemas.EntityValidationV2ResultSuccess;
12327
12858
  export type EntityViewDisabled = Components.Schemas.EntityViewDisabled;
12859
+ export type ErrorObject = Components.Schemas.ErrorObject;
12328
12860
  export type ExportJobId = Components.Schemas.ExportJobId;
12329
12861
  export type FieldsParam = Components.Schemas.FieldsParam;
12330
12862
  export type FileAttribute = Components.Schemas.FileAttribute;
@@ -12344,6 +12876,7 @@ export type IsTemplate = Components.Schemas.IsTemplate;
12344
12876
  export type Language = Components.Schemas.Language;
12345
12877
  export type LinkAttribute = Components.Schemas.LinkAttribute;
12346
12878
  export type ListSavedViewsResults = Components.Schemas.ListSavedViewsResults;
12879
+ export type MessageEmailAddressAttribute = Components.Schemas.MessageEmailAddressAttribute;
12347
12880
  export type MultiSelectAttribute = Components.Schemas.MultiSelectAttribute;
12348
12881
  export type NumberAttribute = Components.Schemas.NumberAttribute;
12349
12882
  export type OrderedListAttribute = Components.Schemas.OrderedListAttribute;
@@ -12359,6 +12892,7 @@ export type RepeatableAttribute = Components.Schemas.RepeatableAttribute;
12359
12892
  export type SavedView = Components.Schemas.SavedView;
12360
12893
  export type SavedViewId = Components.Schemas.SavedViewId;
12361
12894
  export type SavedViewItem = Components.Schemas.SavedViewItem;
12895
+ export type SavedViewPartial = Components.Schemas.SavedViewPartial;
12362
12896
  export type SchemaId = Components.Schemas.SchemaId;
12363
12897
  export type SearchFilter = Components.Schemas.SearchFilter;
12364
12898
  export type SearchFilterValue = Components.Schemas.SearchFilterValue;