@epilot/entity-client 4.16.0-rc1 → 4.16.0-rc3

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.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={914:function(e,t,i){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=r(i(240));t.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}]}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"id"}]},"put":{"operationId":"putSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchema","parameters":[{"in":"path","name":"slug","required":true}]}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"}]}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints"}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"taxonomySlug","required":true},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"dry_run","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"}]},"put":{"operationId":"updateEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}},"patch":{"operationId":"patchEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"dry_run","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}},"required":true}},"delete":{"operationId":"deleteEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false}]}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}]}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}]}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"entities","style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}]}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"},{"in":"query","name":"include_reverse"}]},"post":{"operationId":"addRelations","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"},{"in":"query","name":"query"},{"in":"query","name":"include_reverse"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"fields"}]}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteRelation","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"in":"query","name":"async","required":false}]}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews"}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"in":"path","name":"id","required":true}]},"put":{"operationId":"updateSavedView","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSavedView","parameters":[{"in":"path","name":"id","required":true}]}},"/v1/entity/listTaxonomies":{"get":{"operationId":"listTaxonomies"}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"in":"path","name":"taxonomySlug","required":true}]}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"in":"path","name":"taxonomySlug","required":true},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"in":"path","name":"taxonomySlug","required":true}],"requestBody":{"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},i=function i(r){var a=t[r];if(void 0!==a)return a.exports;var n=t[r]={exports:{}};return e[r].call(n.exports,n,n.exports,i),n.exports}(914),r=exports;for(var a in i)r[a]=i[a];i.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={914:function(e,t,i){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=r(i(240));t.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}]}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"id"}]},"put":{"operationId":"putSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchema","parameters":[{"in":"path","name":"slug","required":true}]}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"}]}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints"}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"taxonomySlug","required":true},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"dry_run","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"}]},"put":{"operationId":"updateEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}}}},"patch":{"operationId":"patchEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false},{"in":"query","name":"dry_run","required":false},{"in":"query","name":"async","required":false}],"requestBody":{"content":{"application/json":{}},"required":true}},"delete":{"operationId":"deleteEntity","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"activity_id","required":false}]}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}]}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}]}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"in":"path","name":"id","required":true},{"in":"query","name":"entities","style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}]}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"},{"in":"query","name":"include_reverse"}]},"post":{"operationId":"addRelations","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"async","required":false},{"in":"query","name":"activity_id","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"hydrate"},{"in":"query","name":"query"},{"in":"query","name":"include_reverse"},{"in":"query","name":"from"},{"in":"query","name":"size"},{"in":"query","name":"fields"}]}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"query","name":"exclude_schemas","required":false,"style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"in":"query","name":"async","required":false},{"in":"query","name":"activity_id","required":false}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteRelation","parameters":[{"in":"path","name":"slug","required":true},{"in":"path","name":"id","required":true},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"in":"query","name":"async","required":false},{"in":"query","name":"activity_id","required":false}]}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews"}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"in":"path","name":"id","required":true}]},"put":{"operationId":"updateSavedView","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSavedView","parameters":[{"in":"path","name":"id","required":true}]}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser"}},"/v1/entity/listTaxonomies":{"get":{"operationId":"listTaxonomies"}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"in":"path","name":"taxonomySlug","required":true}]}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"in":"path","name":"taxonomySlug","required":true},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"in":"path","name":"taxonomySlug","required":true}],"requestBody":{"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},i=function i(r){var a=t[r];if(void 0!==a)return a.exports;var n=t[r]={exports:{}};return e[r].call(n.exports,n,n.exports,i),n.exports}(914),r=exports;for(var a in i)r[a]=i[a];i.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
@@ -457,6 +457,11 @@
457
457
  "in": "query",
458
458
  "name": "async",
459
459
  "required": false
460
+ },
461
+ {
462
+ "in": "query",
463
+ "name": "activity_id",
464
+ "required": false
460
465
  }
461
466
  ],
462
467
  "requestBody": {
@@ -507,6 +512,30 @@
507
512
  ]
508
513
  }
509
514
  },
515
+ "/v2/entity/{slug}/{id}/relations/count": {
516
+ "get": {
517
+ "operationId": "getRelatedEntitiesCount",
518
+ "parameters": [
519
+ {
520
+ "in": "path",
521
+ "name": "slug",
522
+ "required": true
523
+ },
524
+ {
525
+ "in": "path",
526
+ "name": "id",
527
+ "required": true
528
+ },
529
+ {
530
+ "in": "query",
531
+ "name": "exclude_schemas",
532
+ "required": false,
533
+ "style": "form",
534
+ "explode": false
535
+ }
536
+ ]
537
+ }
538
+ },
510
539
  "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
511
540
  "put": {
512
541
  "operationId": "updateRelation",
@@ -535,6 +564,11 @@
535
564
  "in": "query",
536
565
  "name": "async",
537
566
  "required": false
567
+ },
568
+ {
569
+ "in": "query",
570
+ "name": "activity_id",
571
+ "required": false
538
572
  }
539
573
  ],
540
574
  "requestBody": {
@@ -570,6 +604,11 @@
570
604
  "in": "query",
571
605
  "name": "async",
572
606
  "required": false
607
+ },
608
+ {
609
+ "in": "query",
610
+ "name": "activity_id",
611
+ "required": false
573
612
  }
574
613
  ]
575
614
  }
@@ -666,6 +705,11 @@
666
705
  ]
667
706
  }
668
707
  },
708
+ "/v1/entity/views/favorites": {
709
+ "get": {
710
+ "operationId": "listFavoriteViewsForUser"
711
+ }
712
+ },
669
713
  "/v1/entity/listTaxonomies": {
670
714
  "get": {
671
715
  "operationId": "listTaxonomies"
package/dist/openapi.d.ts CHANGED
@@ -158,6 +158,10 @@ declare namespace Components {
158
158
  * Render as a column in table views. When defined, overrides `hidden`
159
159
  */
160
160
  show_in_table?: boolean;
161
+ /**
162
+ * Allow sorting by this attribute in table views if `show_in_table` is true
163
+ */
164
+ sortable?: boolean;
161
165
  required?: boolean;
162
166
  readonly?: boolean;
163
167
  deprecated?: boolean;
@@ -264,7 +268,7 @@ declare namespace Components {
264
268
  type?: "relation_address";
265
269
  has_primary?: boolean;
266
270
  }
267
- export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute;
271
+ export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute;
268
272
  /**
269
273
  * Automation entity
270
274
  */
@@ -280,6 +284,10 @@ declare namespace Components {
280
284
  * Render as a column in table views. When defined, overrides `hidden`
281
285
  */
282
286
  show_in_table?: boolean;
287
+ /**
288
+ * Allow sorting by this attribute in table views if `show_in_table` is true
289
+ */
290
+ sortable?: boolean;
283
291
  required?: boolean;
284
292
  readonly?: boolean;
285
293
  deprecated?: boolean;
@@ -397,6 +405,10 @@ declare namespace Components {
397
405
  * Render as a column in table views. When defined, overrides `hidden`
398
406
  */
399
407
  show_in_table?: boolean;
408
+ /**
409
+ * Allow sorting by this attribute in table views if `show_in_table` is true
410
+ */
411
+ sortable?: boolean;
400
412
  required?: boolean;
401
413
  readonly?: boolean;
402
414
  deprecated?: boolean;
@@ -581,6 +593,10 @@ declare namespace Components {
581
593
  * Render as a column in table views. When defined, overrides `hidden`
582
594
  */
583
595
  show_in_table?: boolean;
596
+ /**
597
+ * Allow sorting by this attribute in table views if `show_in_table` is true
598
+ */
599
+ sortable?: boolean;
584
600
  required?: boolean;
585
601
  readonly?: boolean;
586
602
  deprecated?: boolean;
@@ -707,6 +723,10 @@ declare namespace Components {
707
723
  * Render as a column in table views. When defined, overrides `hidden`
708
724
  */
709
725
  show_in_table?: boolean;
726
+ /**
727
+ * Allow sorting by this attribute in table views if `show_in_table` is true
728
+ */
729
+ sortable?: boolean;
710
730
  required?: boolean;
711
731
  readonly?: boolean;
712
732
  deprecated?: boolean;
@@ -827,6 +847,10 @@ declare namespace Components {
827
847
  * Render as a column in table views. When defined, overrides `hidden`
828
848
  */
829
849
  show_in_table?: boolean;
850
+ /**
851
+ * Allow sorting by this attribute in table views if `show_in_table` is true
852
+ */
853
+ sortable?: boolean;
830
854
  required?: boolean;
831
855
  readonly?: boolean;
832
856
  deprecated?: boolean;
@@ -949,6 +973,10 @@ declare namespace Components {
949
973
  * Render as a column in table views. When defined, overrides `hidden`
950
974
  */
951
975
  show_in_table?: boolean;
976
+ /**
977
+ * Allow sorting by this attribute in table views if `show_in_table` is true
978
+ */
979
+ sortable?: boolean;
952
980
  required?: boolean;
953
981
  readonly?: boolean;
954
982
  deprecated?: boolean;
@@ -1069,6 +1097,10 @@ declare namespace Components {
1069
1097
  * Render as a column in table views. When defined, overrides `hidden`
1070
1098
  */
1071
1099
  show_in_table?: boolean;
1100
+ /**
1101
+ * Allow sorting by this attribute in table views if `show_in_table` is true
1102
+ */
1103
+ sortable?: boolean;
1072
1104
  required?: boolean;
1073
1105
  readonly?: boolean;
1074
1106
  deprecated?: boolean;
@@ -1199,6 +1231,10 @@ declare namespace Components {
1199
1231
  * Render as a column in table views. When defined, overrides `hidden`
1200
1232
  */
1201
1233
  show_in_table?: boolean;
1234
+ /**
1235
+ * Allow sorting by this attribute in table views if `show_in_table` is true
1236
+ */
1237
+ sortable?: boolean;
1202
1238
  required?: boolean;
1203
1239
  readonly?: boolean;
1204
1240
  deprecated?: boolean;
@@ -1374,6 +1410,35 @@ declare namespace Components {
1374
1410
  edit?: string[];
1375
1411
  delete?: string[];
1376
1412
  }
1413
+ /**
1414
+ * An entity action configured from the entity schema
1415
+ */
1416
+ export interface EntityAction {
1417
+ /**
1418
+ * A unique action name
1419
+ * example:
1420
+ * preview_file
1421
+ */
1422
+ action: string;
1423
+ /**
1424
+ * example:
1425
+ * Preview File
1426
+ */
1427
+ label: string;
1428
+ /**
1429
+ * example:
1430
+ * visibility
1431
+ */
1432
+ icon?: string;
1433
+ /**
1434
+ * Permission required to show the action.
1435
+ * If not provided, the action will be shown to all users.
1436
+ *
1437
+ * example:
1438
+ * entity:edit
1439
+ */
1440
+ permission?: string;
1441
+ }
1377
1442
  /**
1378
1443
  * Capabilities the Entity has. Turn features on/off for entities.
1379
1444
  */
@@ -1548,7 +1613,7 @@ declare namespace Components {
1548
1613
  */
1549
1614
  legacy?: boolean;
1550
1615
  })[];
1551
- row_actions?: string[];
1616
+ row_actions?: (("view" | "edit" | "duplicate" | "delete" | "share") | /* An entity action configured from the entity schema */ EntityAction)[];
1552
1617
  navbar_actions?: {
1553
1618
  type: string;
1554
1619
  options?: {
@@ -1979,6 +2044,7 @@ declare namespace Components {
1979
2044
  *
1980
2045
  */
1981
2046
  SummaryAttribute | string)[];
2047
+ quick_actions?: /* An entity action configured from the entity schema */ EntityAction[];
1982
2048
  };
1983
2049
  sharing?: {
1984
2050
  /**
@@ -2235,6 +2301,7 @@ declare namespace Components {
2235
2301
  *
2236
2302
  */
2237
2303
  SummaryAttribute | string)[];
2304
+ quick_actions?: /* An entity action configured from the entity schema */ EntityAction[];
2238
2305
  };
2239
2306
  sharing?: {
2240
2307
  /**
@@ -2532,6 +2599,10 @@ declare namespace Components {
2532
2599
  * Render as a column in table views. When defined, overrides `hidden`
2533
2600
  */
2534
2601
  show_in_table?: boolean;
2602
+ /**
2603
+ * Allow sorting by this attribute in table views if `show_in_table` is true
2604
+ */
2605
+ sortable?: boolean;
2535
2606
  required?: boolean;
2536
2607
  readonly?: boolean;
2537
2608
  deprecated?: boolean;
@@ -2653,6 +2724,13 @@ declare namespace Components {
2653
2724
  enable_description?: boolean;
2654
2725
  default_access_control?: "public-read" | "private";
2655
2726
  }
2727
+ export interface GetRelatedEntitiesCount {
2728
+ /**
2729
+ * example:
2730
+ * 1
2731
+ */
2732
+ hits?: number;
2733
+ }
2656
2734
  export type GetRelationsResp = (RelationItem | /**
2657
2735
  * example:
2658
2736
  * {
@@ -2896,6 +2974,10 @@ declare namespace Components {
2896
2974
  * Render as a column in table views. When defined, overrides `hidden`
2897
2975
  */
2898
2976
  show_in_table?: boolean;
2977
+ /**
2978
+ * Allow sorting by this attribute in table views if `show_in_table` is true
2979
+ */
2980
+ sortable?: boolean;
2899
2981
  required?: boolean;
2900
2982
  readonly?: boolean;
2901
2983
  deprecated?: boolean;
@@ -3016,6 +3098,10 @@ declare namespace Components {
3016
3098
  * Render as a column in table views. When defined, overrides `hidden`
3017
3099
  */
3018
3100
  show_in_table?: boolean;
3101
+ /**
3102
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3103
+ */
3104
+ sortable?: boolean;
3019
3105
  required?: boolean;
3020
3106
  readonly?: boolean;
3021
3107
  deprecated?: boolean;
@@ -3136,6 +3222,10 @@ declare namespace Components {
3136
3222
  * Render as a column in table views. When defined, overrides `hidden`
3137
3223
  */
3138
3224
  show_in_table?: boolean;
3225
+ /**
3226
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3227
+ */
3228
+ sortable?: boolean;
3139
3229
  required?: boolean;
3140
3230
  readonly?: boolean;
3141
3231
  deprecated?: boolean;
@@ -3264,6 +3354,10 @@ declare namespace Components {
3264
3354
  * Render as a column in table views. When defined, overrides `hidden`
3265
3355
  */
3266
3356
  show_in_table?: boolean;
3357
+ /**
3358
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3359
+ */
3360
+ sortable?: boolean;
3267
3361
  required?: boolean;
3268
3362
  readonly?: boolean;
3269
3363
  deprecated?: boolean;
@@ -3384,6 +3478,10 @@ declare namespace Components {
3384
3478
  * Render as a column in table views. When defined, overrides `hidden`
3385
3479
  */
3386
3480
  show_in_table?: boolean;
3481
+ /**
3482
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3483
+ */
3484
+ sortable?: boolean;
3387
3485
  required?: boolean;
3388
3486
  readonly?: boolean;
3389
3487
  deprecated?: boolean;
@@ -3520,6 +3618,10 @@ declare namespace Components {
3520
3618
  * Render as a column in table views. When defined, overrides `hidden`
3521
3619
  */
3522
3620
  show_in_table?: boolean;
3621
+ /**
3622
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3623
+ */
3624
+ sortable?: boolean;
3523
3625
  required?: boolean;
3524
3626
  readonly?: boolean;
3525
3627
  deprecated?: boolean;
@@ -3641,6 +3743,10 @@ declare namespace Components {
3641
3743
  * Render as a column in table views. When defined, overrides `hidden`
3642
3744
  */
3643
3745
  show_in_table?: boolean;
3746
+ /**
3747
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3748
+ */
3749
+ sortable?: boolean;
3644
3750
  required?: boolean;
3645
3751
  readonly?: boolean;
3646
3752
  deprecated?: boolean;
@@ -3746,6 +3852,130 @@ declare namespace Components {
3746
3852
  };
3747
3853
  type?: "ordered_list";
3748
3854
  }
3855
+ /**
3856
+ * Shared Partner Organisations
3857
+ */
3858
+ export interface PartnerOrganisationAttribute {
3859
+ name: string;
3860
+ label: string;
3861
+ placeholder?: string;
3862
+ /**
3863
+ * Do not render attribute in entity views
3864
+ */
3865
+ hidden?: boolean;
3866
+ /**
3867
+ * Render as a column in table views. When defined, overrides `hidden`
3868
+ */
3869
+ show_in_table?: boolean;
3870
+ /**
3871
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3872
+ */
3873
+ sortable?: boolean;
3874
+ required?: boolean;
3875
+ readonly?: boolean;
3876
+ deprecated?: boolean;
3877
+ default_value?: any;
3878
+ /**
3879
+ * Which group the attribute should appear in. Accepts group ID or group name
3880
+ */
3881
+ group?: string;
3882
+ /**
3883
+ * Attribute sort order (ascending) in group
3884
+ * example:
3885
+ * 0
3886
+ */
3887
+ order?: number;
3888
+ /**
3889
+ * example:
3890
+ * full_width
3891
+ */
3892
+ layout?: string;
3893
+ /**
3894
+ * When set to true, will hide the label of the field.
3895
+ */
3896
+ hide_label?: boolean;
3897
+ /**
3898
+ * Code name of the icon to used to represent this attribute.
3899
+ * The value must be a valid @epilot/base-elements Icon name
3900
+ *
3901
+ */
3902
+ icon?: string;
3903
+ /**
3904
+ * Defines the conditional rendering expression for showing this field.
3905
+ * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
3906
+ * Note: Empty or invalid expression have no effect on the field visibility.
3907
+ *
3908
+ */
3909
+ render_condition?: string;
3910
+ _purpose?: ClassificationId /* uuid */[];
3911
+ /**
3912
+ * A set of constraints applicable to the attribute.
3913
+ * These constraints should and will be enforced by the attribute renderer.
3914
+ *
3915
+ * example:
3916
+ * {
3917
+ * "disablePast": true
3918
+ * }
3919
+ */
3920
+ constraints?: {
3921
+ [key: string]: any;
3922
+ };
3923
+ /**
3924
+ * This attribute should only be active when the feature flag is enabled
3925
+ * example:
3926
+ * FF_MY_FEATURE_FLAG
3927
+ */
3928
+ feature_flag?: string;
3929
+ /**
3930
+ * This attribute should only be active when the setting is enabled
3931
+ * example:
3932
+ * MY_SETTING
3933
+ */
3934
+ setting_flag?: string;
3935
+ value_formatter?: string;
3936
+ preview_value_formatter?: string;
3937
+ /**
3938
+ * Setting to `true` disables editing the attribute on the entity builder UI
3939
+ */
3940
+ entity_builder_disable_edit?: boolean;
3941
+ /**
3942
+ * Setting to `true` prevents the attribute from being modified / deleted
3943
+ */
3944
+ protected?: boolean;
3945
+ /**
3946
+ * A set of configurations meant to document and assist the user in filling the attribute.
3947
+ */
3948
+ info_helpers?: {
3949
+ /**
3950
+ * The text to be displayed in the attribute hint helper.
3951
+ * When specified it overrides the `hint_text_key` configuration.
3952
+ *
3953
+ */
3954
+ hint_text?: string;
3955
+ /**
3956
+ * The key of the hint text to be displayed in the attribute hint helper.
3957
+ * The key should be a valid i18n key.
3958
+ *
3959
+ */
3960
+ hint_text_key?: string;
3961
+ /**
3962
+ * The name of the custom component to be used as the hint helper.
3963
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
3964
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
3965
+ *
3966
+ */
3967
+ hint_custom_component?: string;
3968
+ /**
3969
+ * The placement of the hint tooltip.
3970
+ * The value should be a valid `@mui/core` tooltip placement.
3971
+ *
3972
+ * example:
3973
+ * top
3974
+ */
3975
+ hint_tooltip_placement?: string;
3976
+ };
3977
+ type?: "partner_organisation";
3978
+ }
3749
3979
  /**
3750
3980
  * Partner Status
3751
3981
  */
@@ -3761,6 +3991,10 @@ declare namespace Components {
3761
3991
  * Render as a column in table views. When defined, overrides `hidden`
3762
3992
  */
3763
3993
  show_in_table?: boolean;
3994
+ /**
3995
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3996
+ */
3997
+ sortable?: boolean;
3764
3998
  required?: boolean;
3765
3999
  readonly?: boolean;
3766
4000
  deprecated?: boolean;
@@ -3881,6 +4115,10 @@ declare namespace Components {
3881
4115
  * Render as a column in table views. When defined, overrides `hidden`
3882
4116
  */
3883
4117
  show_in_table?: boolean;
4118
+ /**
4119
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4120
+ */
4121
+ sortable?: boolean;
3884
4122
  required?: boolean;
3885
4123
  readonly?: boolean;
3886
4124
  deprecated?: boolean;
@@ -4006,6 +4244,10 @@ declare namespace Components {
4006
4244
  * Render as a column in table views. When defined, overrides `hidden`
4007
4245
  */
4008
4246
  show_in_table?: boolean;
4247
+ /**
4248
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4249
+ */
4250
+ sortable?: boolean;
4009
4251
  required?: boolean;
4010
4252
  readonly?: boolean;
4011
4253
  deprecated?: boolean;
@@ -4145,6 +4387,10 @@ declare namespace Components {
4145
4387
  * Render as a column in table views. When defined, overrides `hidden`
4146
4388
  */
4147
4389
  show_in_table?: boolean;
4390
+ /**
4391
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4392
+ */
4393
+ sortable?: boolean;
4148
4394
  required?: boolean;
4149
4395
  readonly?: boolean;
4150
4396
  deprecated?: boolean;
@@ -4502,6 +4748,10 @@ declare namespace Components {
4502
4748
  * Render as a column in table views. When defined, overrides `hidden`
4503
4749
  */
4504
4750
  show_in_table?: boolean;
4751
+ /**
4752
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4753
+ */
4754
+ sortable?: boolean;
4505
4755
  required?: boolean;
4506
4756
  readonly?: boolean;
4507
4757
  deprecated?: boolean;
@@ -4648,6 +4898,10 @@ declare namespace Components {
4648
4898
  * true
4649
4899
  */
4650
4900
  shared?: boolean;
4901
+ /**
4902
+ * List of users (IDs) that have favorited the view
4903
+ */
4904
+ isFavoritedBy?: string[];
4651
4905
  created_by: {
4652
4906
  /**
4653
4907
  * example:
@@ -4717,6 +4971,10 @@ declare namespace Components {
4717
4971
  * true
4718
4972
  */
4719
4973
  shared?: boolean;
4974
+ /**
4975
+ * List of users (IDs) that have favorited the view
4976
+ */
4977
+ isFavoritedBy?: string[];
4720
4978
  created_by: {
4721
4979
  /**
4722
4980
  * example:
@@ -4787,6 +5045,10 @@ declare namespace Components {
4787
5045
  * Render as a column in table views. When defined, overrides `hidden`
4788
5046
  */
4789
5047
  show_in_table?: boolean;
5048
+ /**
5049
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5050
+ */
5051
+ sortable?: boolean;
4790
5052
  required?: boolean;
4791
5053
  readonly?: boolean;
4792
5054
  deprecated?: boolean;
@@ -4915,6 +5177,10 @@ declare namespace Components {
4915
5177
  * Render as a column in table views. When defined, overrides `hidden`
4916
5178
  */
4917
5179
  show_in_table?: boolean;
5180
+ /**
5181
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5182
+ */
5183
+ sortable?: boolean;
4918
5184
  required?: boolean;
4919
5185
  readonly?: boolean;
4920
5186
  deprecated?: boolean;
@@ -5042,6 +5308,10 @@ declare namespace Components {
5042
5308
  * Render as a column in table views. When defined, overrides `hidden`
5043
5309
  */
5044
5310
  show_in_table?: boolean;
5311
+ /**
5312
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5313
+ */
5314
+ sortable?: boolean;
5045
5315
  required?: boolean;
5046
5316
  readonly?: boolean;
5047
5317
  deprecated?: boolean;
@@ -5232,6 +5502,10 @@ declare namespace Components {
5232
5502
  * Render as a column in table views. When defined, overrides `hidden`
5233
5503
  */
5234
5504
  show_in_table?: boolean;
5505
+ /**
5506
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5507
+ */
5508
+ sortable?: boolean;
5235
5509
  required?: boolean;
5236
5510
  readonly?: boolean;
5237
5511
  deprecated?: boolean;
@@ -5393,6 +5667,10 @@ declare namespace Components {
5393
5667
  * Render as a column in table views. When defined, overrides `hidden`
5394
5668
  */
5395
5669
  show_in_table?: boolean;
5670
+ /**
5671
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5672
+ */
5673
+ sortable?: boolean;
5396
5674
  required?: boolean;
5397
5675
  readonly?: boolean;
5398
5676
  deprecated?: boolean;
@@ -5514,6 +5792,10 @@ declare namespace Components {
5514
5792
  * Render as a column in table views. When defined, overrides `hidden`
5515
5793
  */
5516
5794
  show_in_table?: boolean;
5795
+ /**
5796
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5797
+ */
5798
+ sortable?: boolean;
5517
5799
  required?: boolean;
5518
5800
  readonly?: boolean;
5519
5801
  deprecated?: boolean;
@@ -5625,6 +5907,12 @@ declare namespace Components {
5625
5907
  declare namespace Paths {
5626
5908
  namespace AddRelations {
5627
5909
  namespace Parameters {
5910
+ export type ActivityId = /**
5911
+ * See https://github.com/ulid/spec
5912
+ * example:
5913
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
5914
+ */
5915
+ Components.Schemas.ActivityId /* ulid */;
5628
5916
  export type Async = boolean;
5629
5917
  export type Id = Components.Schemas.EntityId /* uuid */;
5630
5918
  export type Slug = /**
@@ -5640,6 +5928,7 @@ declare namespace Paths {
5640
5928
  }
5641
5929
  export interface QueryParameters {
5642
5930
  async?: Parameters.Async;
5931
+ activity_id?: Parameters.ActivityId;
5643
5932
  }
5644
5933
  export type RequestBody = Components.Schemas.RelationItem[];
5645
5934
  namespace Responses {
@@ -5861,6 +6150,12 @@ declare namespace Paths {
5861
6150
  }
5862
6151
  namespace DeleteRelation {
5863
6152
  namespace Parameters {
6153
+ export type ActivityId = /**
6154
+ * See https://github.com/ulid/spec
6155
+ * example:
6156
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
6157
+ */
6158
+ Components.Schemas.ActivityId /* ulid */;
5864
6159
  export type Async = boolean;
5865
6160
  export type Attribute = string;
5866
6161
  export type EntityId = string;
@@ -5880,6 +6175,7 @@ declare namespace Paths {
5880
6175
  }
5881
6176
  export interface QueryParameters {
5882
6177
  async?: Parameters.Async;
6178
+ activity_id?: Parameters.ActivityId;
5883
6179
  }
5884
6180
  namespace Responses {
5885
6181
  export interface $204 {
@@ -6074,6 +6370,7 @@ declare namespace Paths {
6074
6370
  export type Before = string; // date-time
6075
6371
  export type From = number;
6076
6372
  export type Id = Components.Schemas.EntityId /* uuid */;
6373
+ export type IncludeRelations = boolean;
6077
6374
  export type Size = number;
6078
6375
  export type Slug = /**
6079
6376
  * URL-friendly identifier for the entity schema
@@ -6101,6 +6398,7 @@ declare namespace Paths {
6101
6398
  * SyncActivity
6102
6399
  */
6103
6400
  Parameters.Type;
6401
+ include_relations?: Parameters.IncludeRelations;
6104
6402
  }
6105
6403
  namespace Responses {
6106
6404
  export interface $200 {
@@ -6113,6 +6411,28 @@ declare namespace Paths {
6113
6411
  }
6114
6412
  }
6115
6413
  }
6414
+ namespace GetRelatedEntitiesCount {
6415
+ namespace Parameters {
6416
+ export type ExcludeSchemas = string[];
6417
+ export type Id = Components.Schemas.EntityId /* uuid */;
6418
+ export type Slug = /**
6419
+ * URL-friendly identifier for the entity schema
6420
+ * example:
6421
+ * contact
6422
+ */
6423
+ Components.Schemas.EntitySlug;
6424
+ }
6425
+ export interface PathParameters {
6426
+ slug: Parameters.Slug;
6427
+ id: Parameters.Id;
6428
+ }
6429
+ export interface QueryParameters {
6430
+ exclude_schemas?: Parameters.ExcludeSchemas;
6431
+ }
6432
+ namespace Responses {
6433
+ export type $200 = Components.Schemas.GetRelatedEntitiesCount;
6434
+ }
6435
+ }
6116
6436
  namespace GetRelations {
6117
6437
  namespace Parameters {
6118
6438
  export type Hydrate = boolean;
@@ -6281,6 +6601,13 @@ declare namespace Paths {
6281
6601
  }
6282
6602
  }
6283
6603
  }
6604
+ namespace ListFavoriteViewsForUser {
6605
+ namespace Responses {
6606
+ export interface $200 {
6607
+ results?: /* A saved entity view */ Components.Schemas.SavedViewItem[];
6608
+ }
6609
+ }
6610
+ }
6284
6611
  namespace ListSavedViews {
6285
6612
  namespace Responses {
6286
6613
  export interface $200 {
@@ -6640,6 +6967,12 @@ declare namespace Paths {
6640
6967
  }
6641
6968
  namespace UpdateRelation {
6642
6969
  namespace Parameters {
6970
+ export type ActivityId = /**
6971
+ * See https://github.com/ulid/spec
6972
+ * example:
6973
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
6974
+ */
6975
+ Components.Schemas.ActivityId /* ulid */;
6643
6976
  export type Async = boolean;
6644
6977
  export type Attribute = string;
6645
6978
  export type EntityId = string;
@@ -6659,6 +6992,7 @@ declare namespace Paths {
6659
6992
  }
6660
6993
  export interface QueryParameters {
6661
6994
  async?: Parameters.Async;
6995
+ activity_id?: Parameters.ActivityId;
6662
6996
  }
6663
6997
  export interface RequestBody {
6664
6998
  _tags?: string[];
@@ -7295,6 +7629,17 @@ export interface OperationMethods {
7295
7629
  data?: any,
7296
7630
  config?: AxiosRequestConfig
7297
7631
  ): OperationResponse<Paths.GetRelationsV2.Responses.$200>
7632
+ /**
7633
+ * getRelatedEntitiesCount - getRelatedEntitiesCount
7634
+ *
7635
+ * Returns the amount of unique related entities for an entity - includes direct and reverse relations.
7636
+ *
7637
+ */
7638
+ 'getRelatedEntitiesCount'(
7639
+ parameters?: Parameters<Paths.GetRelatedEntitiesCount.PathParameters & Paths.GetRelatedEntitiesCount.QueryParameters> | null,
7640
+ data?: any,
7641
+ config?: AxiosRequestConfig
7642
+ ): OperationResponse<Paths.GetRelatedEntitiesCount.Responses.$200>
7298
7643
  /**
7299
7644
  * updateRelation - updateRelation
7300
7645
  *
@@ -7388,6 +7733,16 @@ export interface OperationMethods {
7388
7733
  data?: any,
7389
7734
  config?: AxiosRequestConfig
7390
7735
  ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
7736
+ /**
7737
+ * listFavoriteViewsForUser - listFavoriteViewsForUser
7738
+ *
7739
+ * Get the Favorite Saved Views for user based on the schema
7740
+ */
7741
+ 'listFavoriteViewsForUser'(
7742
+ parameters?: Parameters<UnknownParamsObject> | null,
7743
+ data?: any,
7744
+ config?: AxiosRequestConfig
7745
+ ): OperationResponse<Paths.ListFavoriteViewsForUser.Responses.$200>
7391
7746
  /**
7392
7747
  * listTaxonomies - listTaxonomies
7393
7748
  *
@@ -7928,6 +8283,19 @@ export interface PathsDictionary {
7928
8283
  config?: AxiosRequestConfig
7929
8284
  ): OperationResponse<Paths.GetRelationsV2.Responses.$200>
7930
8285
  }
8286
+ ['/v2/entity/{slug}/{id}/relations/count']: {
8287
+ /**
8288
+ * getRelatedEntitiesCount - getRelatedEntitiesCount
8289
+ *
8290
+ * Returns the amount of unique related entities for an entity - includes direct and reverse relations.
8291
+ *
8292
+ */
8293
+ 'get'(
8294
+ parameters?: Parameters<Paths.GetRelatedEntitiesCount.PathParameters & Paths.GetRelatedEntitiesCount.QueryParameters> | null,
8295
+ data?: any,
8296
+ config?: AxiosRequestConfig
8297
+ ): OperationResponse<Paths.GetRelatedEntitiesCount.Responses.$200>
8298
+ }
7931
8299
  ['/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}']: {
7932
8300
  /**
7933
8301
  * updateRelation - updateRelation
@@ -8033,6 +8401,18 @@ export interface PathsDictionary {
8033
8401
  config?: AxiosRequestConfig
8034
8402
  ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
8035
8403
  }
8404
+ ['/v1/entity/views/favorites']: {
8405
+ /**
8406
+ * listFavoriteViewsForUser - listFavoriteViewsForUser
8407
+ *
8408
+ * Get the Favorite Saved Views for user based on the schema
8409
+ */
8410
+ 'get'(
8411
+ parameters?: Parameters<UnknownParamsObject> | null,
8412
+ data?: any,
8413
+ config?: AxiosRequestConfig
8414
+ ): OperationResponse<Paths.ListFavoriteViewsForUser.Responses.$200>
8415
+ }
8036
8416
  ['/v1/entity/listTaxonomies']: {
8037
8417
  /**
8038
8418
  * listTaxonomies - listTaxonomies
package/dist/openapi.json CHANGED
@@ -1322,6 +1322,15 @@
1322
1322
  "type": "boolean",
1323
1323
  "default": false
1324
1324
  }
1325
+ },
1326
+ {
1327
+ "in": "query",
1328
+ "name": "activity_id",
1329
+ "description": "Activity to include in event feed",
1330
+ "required": false,
1331
+ "schema": {
1332
+ "$ref": "#/components/schemas/ActivityId"
1333
+ }
1325
1334
  }
1326
1335
  ],
1327
1336
  "requestBody": {
@@ -1471,6 +1480,63 @@
1471
1480
  }
1472
1481
  }
1473
1482
  },
1483
+ "/v2/entity/{slug}/{id}/relations/count": {
1484
+ "get": {
1485
+ "operationId": "getRelatedEntitiesCount",
1486
+ "summary": "getRelatedEntitiesCount",
1487
+ "description": "Returns the amount of unique related entities for an entity - includes direct and reverse relations.\n",
1488
+ "tags": [
1489
+ "Relations"
1490
+ ],
1491
+ "parameters": [
1492
+ {
1493
+ "in": "path",
1494
+ "name": "slug",
1495
+ "description": "Entity Schema",
1496
+ "required": true,
1497
+ "schema": {
1498
+ "$ref": "#/components/schemas/EntitySlug"
1499
+ }
1500
+ },
1501
+ {
1502
+ "in": "path",
1503
+ "name": "id",
1504
+ "description": "Entity id",
1505
+ "required": true,
1506
+ "schema": {
1507
+ "$ref": "#/components/schemas/EntityId"
1508
+ }
1509
+ },
1510
+ {
1511
+ "in": "query",
1512
+ "name": "exclude_schemas",
1513
+ "description": "To be excluded from the count by given schemas",
1514
+ "required": false,
1515
+ "style": "form",
1516
+ "example": "<url>/count?exclude_schemas=file,message",
1517
+ "explode": false,
1518
+ "schema": {
1519
+ "type": "array",
1520
+ "items": {
1521
+ "type": "string"
1522
+ }
1523
+ }
1524
+ }
1525
+ ],
1526
+ "responses": {
1527
+ "200": {
1528
+ "description": "Success",
1529
+ "content": {
1530
+ "application/json": {
1531
+ "schema": {
1532
+ "$ref": "#/components/schemas/GetRelatedEntitiesCount"
1533
+ }
1534
+ }
1535
+ }
1536
+ }
1537
+ }
1538
+ }
1539
+ },
1474
1540
  "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
1475
1541
  "put": {
1476
1542
  "operationId": "updateRelation",
@@ -1525,6 +1591,15 @@
1525
1591
  "type": "boolean",
1526
1592
  "default": false
1527
1593
  }
1594
+ },
1595
+ {
1596
+ "in": "query",
1597
+ "name": "activity_id",
1598
+ "description": "Activity to include in event feed",
1599
+ "required": false,
1600
+ "schema": {
1601
+ "$ref": "#/components/schemas/ActivityId"
1602
+ }
1528
1603
  }
1529
1604
  ],
1530
1605
  "requestBody": {
@@ -1616,6 +1691,15 @@
1616
1691
  "type": "boolean",
1617
1692
  "default": false
1618
1693
  }
1694
+ },
1695
+ {
1696
+ "in": "query",
1697
+ "name": "activity_id",
1698
+ "description": "Activity to include in event feed",
1699
+ "required": false,
1700
+ "schema": {
1701
+ "$ref": "#/components/schemas/ActivityId"
1702
+ }
1619
1703
  }
1620
1704
  ],
1621
1705
  "responses": {
@@ -1872,6 +1956,36 @@
1872
1956
  }
1873
1957
  }
1874
1958
  },
1959
+ "/v1/entity/views/favorites": {
1960
+ "get": {
1961
+ "operationId": "listFavoriteViewsForUser",
1962
+ "summary": "listFavoriteViewsForUser",
1963
+ "description": "Get the Favorite Saved Views for user based on the schema",
1964
+ "tags": [
1965
+ "Saved Views"
1966
+ ],
1967
+ "responses": {
1968
+ "200": {
1969
+ "description": "Success",
1970
+ "content": {
1971
+ "application/json": {
1972
+ "schema": {
1973
+ "type": "object",
1974
+ "properties": {
1975
+ "results": {
1976
+ "type": "array",
1977
+ "items": {
1978
+ "$ref": "#/components/schemas/SavedViewItem"
1979
+ }
1980
+ }
1981
+ }
1982
+ }
1983
+ }
1984
+ }
1985
+ }
1986
+ }
1987
+ }
1988
+ },
1875
1989
  "/v1/entity/listTaxonomies": {
1876
1990
  "get": {
1877
1991
  "operationId": "listTaxonomies",
@@ -2272,6 +2386,12 @@
2272
2386
  }
2273
2387
  ]
2274
2388
  }
2389
+ },
2390
+ "quick_actions": {
2391
+ "type": "array",
2392
+ "items": {
2393
+ "$ref": "#/components/schemas/EntityAction"
2394
+ }
2275
2395
  }
2276
2396
  }
2277
2397
  },
@@ -2567,6 +2687,9 @@
2567
2687
  },
2568
2688
  {
2569
2689
  "$ref": "#/components/schemas/PurposeAttribute"
2690
+ },
2691
+ {
2692
+ "$ref": "#/components/schemas/PartnerOrganisationAttribute"
2570
2693
  }
2571
2694
  ]
2572
2695
  },
@@ -2591,6 +2714,11 @@
2591
2714
  "description": "Render as a column in table views. When defined, overrides `hidden`",
2592
2715
  "type": "boolean"
2593
2716
  },
2717
+ "sortable": {
2718
+ "description": "Allow sorting by this attribute in table views if `show_in_table` is true",
2719
+ "type": "boolean",
2720
+ "default": true
2721
+ },
2594
2722
  "required": {
2595
2723
  "type": "boolean",
2596
2724
  "default": false
@@ -3124,6 +3252,34 @@
3124
3252
  }
3125
3253
  }
3126
3254
  },
3255
+ "EntityAction": {
3256
+ "type": "object",
3257
+ "description": "An entity action configured from the entity schema",
3258
+ "properties": {
3259
+ "action": {
3260
+ "type": "string",
3261
+ "description": "A unique action name",
3262
+ "example": "preview_file"
3263
+ },
3264
+ "label": {
3265
+ "type": "string",
3266
+ "example": "Preview File"
3267
+ },
3268
+ "icon": {
3269
+ "type": "string",
3270
+ "example": "visibility"
3271
+ },
3272
+ "permission": {
3273
+ "type": "string",
3274
+ "example": "entity:edit",
3275
+ "description": "Permission required to show the action.\nIf not provided, the action will be shown to all users.\n"
3276
+ }
3277
+ },
3278
+ "required": [
3279
+ "action",
3280
+ "label"
3281
+ ]
3282
+ },
3127
3283
  "RelationAttribute": {
3128
3284
  "allOf": [
3129
3285
  {
@@ -3314,6 +3470,25 @@
3314
3470
  }
3315
3471
  ]
3316
3472
  },
3473
+ "PartnerOrganisationAttribute": {
3474
+ "allOf": [
3475
+ {
3476
+ "$ref": "#/components/schemas/BaseAttribute"
3477
+ },
3478
+ {
3479
+ "type": "object",
3480
+ "description": "Shared Partner Organisations",
3481
+ "properties": {
3482
+ "type": {
3483
+ "type": "string",
3484
+ "enum": [
3485
+ "partner_organisation"
3486
+ ]
3487
+ }
3488
+ }
3489
+ }
3490
+ ]
3491
+ },
3317
3492
  "AddressRelationAttribute": {
3318
3493
  "allOf": [
3319
3494
  {
@@ -3872,7 +4047,21 @@
3872
4047
  "row_actions": {
3873
4048
  "type": "array",
3874
4049
  "items": {
3875
- "type": "string"
4050
+ "anyOf": [
4051
+ {
4052
+ "type": "string",
4053
+ "enum": [
4054
+ "view",
4055
+ "edit",
4056
+ "duplicate",
4057
+ "delete",
4058
+ "share"
4059
+ ]
4060
+ },
4061
+ {
4062
+ "$ref": "#/components/schemas/EntityAction"
4063
+ }
4064
+ ]
3876
4065
  }
3877
4066
  },
3878
4067
  "navbar_actions": {
@@ -4268,6 +4457,15 @@
4268
4457
  }
4269
4458
  }
4270
4459
  },
4460
+ "GetRelatedEntitiesCount": {
4461
+ "type": "object",
4462
+ "properties": {
4463
+ "hits": {
4464
+ "type": "integer",
4465
+ "example": 1
4466
+ }
4467
+ }
4468
+ },
4271
4469
  "RelationEntity": {
4272
4470
  "allOf": [
4273
4471
  {
@@ -4739,6 +4937,14 @@
4739
4937
  "type": "boolean",
4740
4938
  "example": true
4741
4939
  },
4940
+ "isFavoritedBy": {
4941
+ "description": "List of users (IDs) that have favorited the view",
4942
+ "type": "array",
4943
+ "items": {
4944
+ "type": "string",
4945
+ "example": 11701
4946
+ }
4947
+ },
4742
4948
  "created_by": {
4743
4949
  "anyOf": [
4744
4950
  {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "4.16.0-rc1",
3
+ "version": "4.16.0-rc3",
4
4
  "description": "JavaScript client library for the epilot Core Entity API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",