@epilot/entity-client 4.34.2 → 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
  /**
@@ -514,7 +538,7 @@ declare namespace Components {
514
538
  has_primary?: boolean;
515
539
  default_address_fields?: /* Default fields visible on addresses */ DefaultAddressFields;
516
540
  }
517
- 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;
518
542
  /**
519
543
  * a readonly computed ID for the attribute including schema slug and the attribute ID
520
544
  */
@@ -530,7 +554,7 @@ declare namespace Components {
530
554
  * contact
531
555
  */
532
556
  schema?: string;
533
- } & (/* 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);
534
558
  /**
535
559
  * Automation entity
536
560
  */
@@ -2710,6 +2734,12 @@ declare namespace Components {
2710
2734
  */
2711
2735
  SummaryAttribute | string)[];
2712
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
+ };
2713
2743
  };
2714
2744
  sharing?: {
2715
2745
  /**
@@ -3084,6 +3114,12 @@ declare namespace Components {
3084
3114
  */
3085
3115
  SummaryAttribute | string)[];
3086
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
+ };
3087
3123
  };
3088
3124
  sharing?: {
3089
3125
  /**
@@ -3581,6 +3617,23 @@ declare namespace Components {
3581
3617
  export interface EntityViewDisabled {
3582
3618
  view_type?: "disabled";
3583
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
+ }
3584
3637
  /**
3585
3638
  * The unique identifier of the import job.
3586
3639
  * example:
@@ -4646,6 +4699,145 @@ declare namespace Components {
4646
4699
  hits?: number;
4647
4700
  results?: /* A saved entity view */ SavedViewItem[];
4648
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
+ }
4649
4841
  /**
4650
4842
  * Multi Choice Selection
4651
4843
  */
@@ -6051,6 +6243,10 @@ declare namespace Components {
6051
6243
  }
6052
6244
  export interface RelationItem {
6053
6245
  entity_id: EntityId /* uuid */;
6246
+ /**
6247
+ * Organization Id the entity belongs to
6248
+ */
6249
+ org_id?: string;
6054
6250
  attribute: string;
6055
6251
  _tags?: string[];
6056
6252
  /**
@@ -6198,7 +6394,7 @@ declare namespace Components {
6198
6394
  * Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.
6199
6395
  */
6200
6396
  relation_affinity_mode?: "weak" | "strong";
6201
- type?: "string" | "phone" | "email" | "address" | "relation" | "payment" | "price_component" | "date";
6397
+ type?: "string" | "phone" | "email" | "address" | "relation" | "payment" | "price_component" | "date" | "message_email_address";
6202
6398
  /**
6203
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.
6204
6400
  */
@@ -6269,6 +6465,10 @@ declare namespace Components {
6269
6465
  ui_config: {
6270
6466
  [name: string]: any;
6271
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[];
6272
6472
  }
6273
6473
  /**
6274
6474
  * Generated uuid for a saved view
@@ -6342,6 +6542,80 @@ declare namespace Components {
6342
6542
  ui_config: {
6343
6543
  [name: string]: any;
6344
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[];
6345
6619
  }
6346
6620
  /**
6347
6621
  * Generated uuid for schema
@@ -7016,6 +7290,32 @@ declare namespace Components {
7016
7290
  * This summary attribute should only be visible when all the settings have the correct value
7017
7291
  */
7018
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;
7019
7319
  }
7020
7320
  /**
7021
7321
  * Summary Fields are displayed inside list view as a resume of the relation entity.
@@ -7640,6 +7940,15 @@ declare namespace Paths {
7640
7940
  export type RequestBody = Components.Schemas.RelationItem[];
7641
7941
  namespace Responses {
7642
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;
7643
7952
  }
7644
7953
  }
7645
7954
  namespace AttachActivity {
@@ -7660,6 +7969,15 @@ declare namespace Paths {
7660
7969
  }
7661
7970
  namespace Responses {
7662
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;
7663
7981
  }
7664
7982
  }
7665
7983
  namespace Autocomplete {
@@ -7974,6 +8292,15 @@ declare namespace Paths {
7974
8292
  namespace Responses {
7975
8293
  export interface $204 {
7976
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;
7977
8304
  }
7978
8305
  }
7979
8306
  namespace DeleteSavedView {
@@ -8150,6 +8477,15 @@ declare namespace Paths {
8150
8477
  }
8151
8478
  namespace Responses {
8152
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;
8153
8489
  }
8154
8490
  }
8155
8491
  namespace GetEntity {
@@ -8267,6 +8603,15 @@ declare namespace Paths {
8267
8603
  */
8268
8604
  Components.Schemas.EntityItem[];
8269
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;
8270
8615
  }
8271
8616
  }
8272
8617
  namespace GetEntityActivityFeed {
@@ -8314,6 +8659,15 @@ declare namespace Paths {
8314
8659
  total?: number;
8315
8660
  results?: Components.Schemas.ActivityItem[];
8316
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;
8317
8671
  }
8318
8672
  }
8319
8673
  namespace GetEntityV2 {
@@ -8401,6 +8755,15 @@ declare namespace Paths {
8401
8755
  * }
8402
8756
  */
8403
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;
8404
8767
  }
8405
8768
  }
8406
8769
  namespace GetJsonSchema {
@@ -8744,6 +9107,15 @@ declare namespace Paths {
8744
9107
  }
8745
9108
  namespace Responses {
8746
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;
8747
9119
  }
8748
9120
  }
8749
9121
  namespace GetRelations {
@@ -8786,6 +9158,15 @@ declare namespace Paths {
8786
9158
  }
8787
9159
  namespace Responses {
8788
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;
8789
9170
  }
8790
9171
  }
8791
9172
  namespace GetRelationsV2 {
@@ -8835,6 +9216,15 @@ declare namespace Paths {
8835
9216
  }
8836
9217
  namespace Responses {
8837
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;
8838
9228
  }
8839
9229
  }
8840
9230
  namespace GetRelationsV3 {
@@ -8879,6 +9269,15 @@ declare namespace Paths {
8879
9269
  }
8880
9270
  namespace Responses {
8881
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;
8882
9281
  }
8883
9282
  }
8884
9283
  namespace GetSavedView {
@@ -8890,6 +9289,15 @@ declare namespace Paths {
8890
9289
  }
8891
9290
  namespace Responses {
8892
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;
8893
9301
  }
8894
9302
  }
8895
9303
  namespace GetSchema {
@@ -8910,6 +9318,15 @@ declare namespace Paths {
8910
9318
  }
8911
9319
  namespace Responses {
8912
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;
8913
9330
  }
8914
9331
  }
8915
9332
  namespace GetSchemaAttribute {
@@ -8929,6 +9346,15 @@ declare namespace Paths {
8929
9346
  }
8930
9347
  namespace Responses {
8931
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;
8932
9358
  }
8933
9359
  }
8934
9360
  namespace GetSchemaCapability {
@@ -8948,6 +9374,15 @@ declare namespace Paths {
8948
9374
  }
8949
9375
  namespace Responses {
8950
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;
8951
9386
  }
8952
9387
  }
8953
9388
  namespace GetSchemaExample {
@@ -8984,6 +9419,15 @@ declare namespace Paths {
8984
9419
  }
8985
9420
  namespace Responses {
8986
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;
8987
9431
  }
8988
9432
  }
8989
9433
  namespace GetSchemaGroupHeadline {
@@ -9003,6 +9447,15 @@ declare namespace Paths {
9003
9447
  }
9004
9448
  namespace Responses {
9005
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;
9006
9459
  }
9007
9460
  }
9008
9461
  namespace GetSchemaVersions {
@@ -9061,6 +9514,15 @@ declare namespace Paths {
9061
9514
  }
9062
9515
  namespace Responses {
9063
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;
9064
9526
  }
9065
9527
  }
9066
9528
  namespace GetTaxonomyBulkActionJobById {
@@ -9120,8 +9582,15 @@ declare namespace Paths {
9120
9582
  }
9121
9583
  namespace Responses {
9122
9584
  export type $200 = Components.Schemas.TaxonomyClassification;
9123
- export interface $404 {
9124
- }
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;
9125
9594
  }
9126
9595
  }
9127
9596
  namespace ImportEntities {
@@ -9375,6 +9844,18 @@ declare namespace Paths {
9375
9844
  export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9376
9845
  }
9377
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
+ }
9378
9859
  namespace PutSchema {
9379
9860
  namespace Parameters {
9380
9861
  export type Draft = boolean;
@@ -9505,6 +9986,15 @@ declare namespace Paths {
9505
9986
  namespace Responses {
9506
9987
  export interface $204 {
9507
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;
9508
9998
  }
9509
9999
  }
9510
10000
  namespace RestoreEntity {
@@ -9670,6 +10160,15 @@ declare namespace Paths {
9670
10160
  [key: string]: any;
9671
10161
  };
9672
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;
9673
10172
  }
9674
10173
  }
9675
10174
  namespace UpdateEntity {
@@ -9822,6 +10321,15 @@ declare namespace Paths {
9822
10321
  }
9823
10322
  namespace Responses {
9824
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;
9825
10333
  }
9826
10334
  }
9827
10335
  namespace UpdateSavedView {
@@ -10811,6 +11319,16 @@ export interface OperationMethods {
10811
11319
  data?: Paths.UpdateSavedView.RequestBody,
10812
11320
  config?: AxiosRequestConfig
10813
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>
10814
11332
  /**
10815
11333
  * deleteSavedView - deleteSavedView
10816
11334
  *
@@ -11875,6 +12393,16 @@ export interface PathsDictionary {
11875
12393
  data?: Paths.UpdateSavedView.RequestBody,
11876
12394
  config?: AxiosRequestConfig
11877
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>
11878
12406
  /**
11879
12407
  * deleteSavedView - deleteSavedView
11880
12408
  *
@@ -12328,6 +12856,7 @@ export type EntityValidationV2Result = Components.Schemas.EntityValidationV2Resu
12328
12856
  export type EntityValidationV2ResultError = Components.Schemas.EntityValidationV2ResultError;
12329
12857
  export type EntityValidationV2ResultSuccess = Components.Schemas.EntityValidationV2ResultSuccess;
12330
12858
  export type EntityViewDisabled = Components.Schemas.EntityViewDisabled;
12859
+ export type ErrorObject = Components.Schemas.ErrorObject;
12331
12860
  export type ExportJobId = Components.Schemas.ExportJobId;
12332
12861
  export type FieldsParam = Components.Schemas.FieldsParam;
12333
12862
  export type FileAttribute = Components.Schemas.FileAttribute;
@@ -12347,6 +12876,7 @@ export type IsTemplate = Components.Schemas.IsTemplate;
12347
12876
  export type Language = Components.Schemas.Language;
12348
12877
  export type LinkAttribute = Components.Schemas.LinkAttribute;
12349
12878
  export type ListSavedViewsResults = Components.Schemas.ListSavedViewsResults;
12879
+ export type MessageEmailAddressAttribute = Components.Schemas.MessageEmailAddressAttribute;
12350
12880
  export type MultiSelectAttribute = Components.Schemas.MultiSelectAttribute;
12351
12881
  export type NumberAttribute = Components.Schemas.NumberAttribute;
12352
12882
  export type OrderedListAttribute = Components.Schemas.OrderedListAttribute;
@@ -12362,6 +12892,7 @@ export type RepeatableAttribute = Components.Schemas.RepeatableAttribute;
12362
12892
  export type SavedView = Components.Schemas.SavedView;
12363
12893
  export type SavedViewId = Components.Schemas.SavedViewId;
12364
12894
  export type SavedViewItem = Components.Schemas.SavedViewItem;
12895
+ export type SavedViewPartial = Components.Schemas.SavedViewPartial;
12365
12896
  export type SchemaId = Components.Schemas.SchemaId;
12366
12897
  export type SearchFilter = Components.Schemas.SearchFilter;
12367
12898
  export type SearchFilterValue = Components.Schemas.SearchFilterValue;