@epilot/entity-client 4.15.3 → 4.15.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.ts CHANGED
File without changes
package/dist/client.js CHANGED
File without changes
File without changes
@@ -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"},{"in":"query","name":"from"},{"in":"query","name":"size","required":false},{"in":"query","name":"include_schemas","required":false,"style":"form","explode":false},{"in":"query","name":"exclude_schemas","required":false,"style":"form","explode":false}]},"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})})();
package/dist/index.d.ts CHANGED
File without changes
package/dist/index.js CHANGED
File without changes
@@ -437,6 +437,29 @@
437
437
  {
438
438
  "in": "query",
439
439
  "name": "include_reverse"
440
+ },
441
+ {
442
+ "in": "query",
443
+ "name": "from"
444
+ },
445
+ {
446
+ "in": "query",
447
+ "name": "size",
448
+ "required": false
449
+ },
450
+ {
451
+ "in": "query",
452
+ "name": "include_schemas",
453
+ "required": false,
454
+ "style": "form",
455
+ "explode": false
456
+ },
457
+ {
458
+ "in": "query",
459
+ "name": "exclude_schemas",
460
+ "required": false,
461
+ "style": "form",
462
+ "explode": false
440
463
  }
441
464
  ]
442
465
  },
@@ -457,6 +480,11 @@
457
480
  "in": "query",
458
481
  "name": "async",
459
482
  "required": false
483
+ },
484
+ {
485
+ "in": "query",
486
+ "name": "activity_id",
487
+ "required": false
460
488
  }
461
489
  ],
462
490
  "requestBody": {
@@ -507,6 +535,30 @@
507
535
  ]
508
536
  }
509
537
  },
538
+ "/v2/entity/{slug}/{id}/relations/count": {
539
+ "get": {
540
+ "operationId": "getRelatedEntitiesCount",
541
+ "parameters": [
542
+ {
543
+ "in": "path",
544
+ "name": "slug",
545
+ "required": true
546
+ },
547
+ {
548
+ "in": "path",
549
+ "name": "id",
550
+ "required": true
551
+ },
552
+ {
553
+ "in": "query",
554
+ "name": "exclude_schemas",
555
+ "required": false,
556
+ "style": "form",
557
+ "explode": false
558
+ }
559
+ ]
560
+ }
561
+ },
510
562
  "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
511
563
  "put": {
512
564
  "operationId": "updateRelation",
@@ -535,6 +587,11 @@
535
587
  "in": "query",
536
588
  "name": "async",
537
589
  "required": false
590
+ },
591
+ {
592
+ "in": "query",
593
+ "name": "activity_id",
594
+ "required": false
538
595
  }
539
596
  ],
540
597
  "requestBody": {
@@ -570,6 +627,11 @@
570
627
  "in": "query",
571
628
  "name": "async",
572
629
  "required": false
630
+ },
631
+ {
632
+ "in": "query",
633
+ "name": "activity_id",
634
+ "required": false
573
635
  }
574
636
  ]
575
637
  }
@@ -666,6 +728,11 @@
666
728
  ]
667
729
  }
668
730
  },
731
+ "/v1/entity/views/favorites": {
732
+ "get": {
733
+ "operationId": "listFavoriteViewsForUser"
734
+ }
735
+ },
669
736
  "/v1/entity/listTaxonomies": {
670
737
  "get": {
671
738
  "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;
@@ -2532,6 +2568,10 @@ declare namespace Components {
2532
2568
  * Render as a column in table views. When defined, overrides `hidden`
2533
2569
  */
2534
2570
  show_in_table?: boolean;
2571
+ /**
2572
+ * Allow sorting by this attribute in table views if `show_in_table` is true
2573
+ */
2574
+ sortable?: boolean;
2535
2575
  required?: boolean;
2536
2576
  readonly?: boolean;
2537
2577
  deprecated?: boolean;
@@ -2653,6 +2693,13 @@ declare namespace Components {
2653
2693
  enable_description?: boolean;
2654
2694
  default_access_control?: "public-read" | "private";
2655
2695
  }
2696
+ export interface GetRelatedEntitiesCount {
2697
+ /**
2698
+ * example:
2699
+ * 1
2700
+ */
2701
+ hits?: number;
2702
+ }
2656
2703
  export type GetRelationsResp = (RelationItem | /**
2657
2704
  * example:
2658
2705
  * {
@@ -2896,6 +2943,10 @@ declare namespace Components {
2896
2943
  * Render as a column in table views. When defined, overrides `hidden`
2897
2944
  */
2898
2945
  show_in_table?: boolean;
2946
+ /**
2947
+ * Allow sorting by this attribute in table views if `show_in_table` is true
2948
+ */
2949
+ sortable?: boolean;
2899
2950
  required?: boolean;
2900
2951
  readonly?: boolean;
2901
2952
  deprecated?: boolean;
@@ -3016,6 +3067,10 @@ declare namespace Components {
3016
3067
  * Render as a column in table views. When defined, overrides `hidden`
3017
3068
  */
3018
3069
  show_in_table?: boolean;
3070
+ /**
3071
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3072
+ */
3073
+ sortable?: boolean;
3019
3074
  required?: boolean;
3020
3075
  readonly?: boolean;
3021
3076
  deprecated?: boolean;
@@ -3136,6 +3191,10 @@ declare namespace Components {
3136
3191
  * Render as a column in table views. When defined, overrides `hidden`
3137
3192
  */
3138
3193
  show_in_table?: boolean;
3194
+ /**
3195
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3196
+ */
3197
+ sortable?: boolean;
3139
3198
  required?: boolean;
3140
3199
  readonly?: boolean;
3141
3200
  deprecated?: boolean;
@@ -3264,6 +3323,10 @@ declare namespace Components {
3264
3323
  * Render as a column in table views. When defined, overrides `hidden`
3265
3324
  */
3266
3325
  show_in_table?: boolean;
3326
+ /**
3327
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3328
+ */
3329
+ sortable?: boolean;
3267
3330
  required?: boolean;
3268
3331
  readonly?: boolean;
3269
3332
  deprecated?: boolean;
@@ -3384,6 +3447,10 @@ declare namespace Components {
3384
3447
  * Render as a column in table views. When defined, overrides `hidden`
3385
3448
  */
3386
3449
  show_in_table?: boolean;
3450
+ /**
3451
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3452
+ */
3453
+ sortable?: boolean;
3387
3454
  required?: boolean;
3388
3455
  readonly?: boolean;
3389
3456
  deprecated?: boolean;
@@ -3520,6 +3587,10 @@ declare namespace Components {
3520
3587
  * Render as a column in table views. When defined, overrides `hidden`
3521
3588
  */
3522
3589
  show_in_table?: boolean;
3590
+ /**
3591
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3592
+ */
3593
+ sortable?: boolean;
3523
3594
  required?: boolean;
3524
3595
  readonly?: boolean;
3525
3596
  deprecated?: boolean;
@@ -3641,6 +3712,10 @@ declare namespace Components {
3641
3712
  * Render as a column in table views. When defined, overrides `hidden`
3642
3713
  */
3643
3714
  show_in_table?: boolean;
3715
+ /**
3716
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3717
+ */
3718
+ sortable?: boolean;
3644
3719
  required?: boolean;
3645
3720
  readonly?: boolean;
3646
3721
  deprecated?: boolean;
@@ -3746,6 +3821,130 @@ declare namespace Components {
3746
3821
  };
3747
3822
  type?: "ordered_list";
3748
3823
  }
3824
+ /**
3825
+ * Shared Partner Organisations
3826
+ */
3827
+ export interface PartnerOrganisationAttribute {
3828
+ name: string;
3829
+ label: string;
3830
+ placeholder?: string;
3831
+ /**
3832
+ * Do not render attribute in entity views
3833
+ */
3834
+ hidden?: boolean;
3835
+ /**
3836
+ * Render as a column in table views. When defined, overrides `hidden`
3837
+ */
3838
+ show_in_table?: boolean;
3839
+ /**
3840
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3841
+ */
3842
+ sortable?: boolean;
3843
+ required?: boolean;
3844
+ readonly?: boolean;
3845
+ deprecated?: boolean;
3846
+ default_value?: any;
3847
+ /**
3848
+ * Which group the attribute should appear in. Accepts group ID or group name
3849
+ */
3850
+ group?: string;
3851
+ /**
3852
+ * Attribute sort order (ascending) in group
3853
+ * example:
3854
+ * 0
3855
+ */
3856
+ order?: number;
3857
+ /**
3858
+ * example:
3859
+ * full_width
3860
+ */
3861
+ layout?: string;
3862
+ /**
3863
+ * When set to true, will hide the label of the field.
3864
+ */
3865
+ hide_label?: boolean;
3866
+ /**
3867
+ * Code name of the icon to used to represent this attribute.
3868
+ * The value must be a valid @epilot/base-elements Icon name
3869
+ *
3870
+ */
3871
+ icon?: string;
3872
+ /**
3873
+ * Defines the conditional rendering expression for showing this field.
3874
+ * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
3875
+ * Note: Empty or invalid expression have no effect on the field visibility.
3876
+ *
3877
+ */
3878
+ render_condition?: string;
3879
+ _purpose?: ClassificationId /* uuid */[];
3880
+ /**
3881
+ * A set of constraints applicable to the attribute.
3882
+ * These constraints should and will be enforced by the attribute renderer.
3883
+ *
3884
+ * example:
3885
+ * {
3886
+ * "disablePast": true
3887
+ * }
3888
+ */
3889
+ constraints?: {
3890
+ [key: string]: any;
3891
+ };
3892
+ /**
3893
+ * This attribute should only be active when the feature flag is enabled
3894
+ * example:
3895
+ * FF_MY_FEATURE_FLAG
3896
+ */
3897
+ feature_flag?: string;
3898
+ /**
3899
+ * This attribute should only be active when the setting is enabled
3900
+ * example:
3901
+ * MY_SETTING
3902
+ */
3903
+ setting_flag?: string;
3904
+ value_formatter?: string;
3905
+ preview_value_formatter?: string;
3906
+ /**
3907
+ * Setting to `true` disables editing the attribute on the entity builder UI
3908
+ */
3909
+ entity_builder_disable_edit?: boolean;
3910
+ /**
3911
+ * Setting to `true` prevents the attribute from being modified / deleted
3912
+ */
3913
+ protected?: boolean;
3914
+ /**
3915
+ * A set of configurations meant to document and assist the user in filling the attribute.
3916
+ */
3917
+ info_helpers?: {
3918
+ /**
3919
+ * The text to be displayed in the attribute hint helper.
3920
+ * When specified it overrides the `hint_text_key` configuration.
3921
+ *
3922
+ */
3923
+ hint_text?: string;
3924
+ /**
3925
+ * The key of the hint text to be displayed in the attribute hint helper.
3926
+ * The key should be a valid i18n key.
3927
+ *
3928
+ */
3929
+ hint_text_key?: string;
3930
+ /**
3931
+ * The name of the custom component to be used as the hint helper.
3932
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
3933
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
3934
+ *
3935
+ */
3936
+ hint_custom_component?: string;
3937
+ /**
3938
+ * The placement of the hint tooltip.
3939
+ * The value should be a valid `@mui/core` tooltip placement.
3940
+ *
3941
+ * example:
3942
+ * top
3943
+ */
3944
+ hint_tooltip_placement?: string;
3945
+ };
3946
+ type?: "partner_organisation";
3947
+ }
3749
3948
  /**
3750
3949
  * Partner Status
3751
3950
  */
@@ -3761,6 +3960,10 @@ declare namespace Components {
3761
3960
  * Render as a column in table views. When defined, overrides `hidden`
3762
3961
  */
3763
3962
  show_in_table?: boolean;
3963
+ /**
3964
+ * Allow sorting by this attribute in table views if `show_in_table` is true
3965
+ */
3966
+ sortable?: boolean;
3764
3967
  required?: boolean;
3765
3968
  readonly?: boolean;
3766
3969
  deprecated?: boolean;
@@ -3881,6 +4084,10 @@ declare namespace Components {
3881
4084
  * Render as a column in table views. When defined, overrides `hidden`
3882
4085
  */
3883
4086
  show_in_table?: boolean;
4087
+ /**
4088
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4089
+ */
4090
+ sortable?: boolean;
3884
4091
  required?: boolean;
3885
4092
  readonly?: boolean;
3886
4093
  deprecated?: boolean;
@@ -4006,6 +4213,10 @@ declare namespace Components {
4006
4213
  * Render as a column in table views. When defined, overrides `hidden`
4007
4214
  */
4008
4215
  show_in_table?: boolean;
4216
+ /**
4217
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4218
+ */
4219
+ sortable?: boolean;
4009
4220
  required?: boolean;
4010
4221
  readonly?: boolean;
4011
4222
  deprecated?: boolean;
@@ -4145,6 +4356,10 @@ declare namespace Components {
4145
4356
  * Render as a column in table views. When defined, overrides `hidden`
4146
4357
  */
4147
4358
  show_in_table?: boolean;
4359
+ /**
4360
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4361
+ */
4362
+ sortable?: boolean;
4148
4363
  required?: boolean;
4149
4364
  readonly?: boolean;
4150
4365
  deprecated?: boolean;
@@ -4502,6 +4717,10 @@ declare namespace Components {
4502
4717
  * Render as a column in table views. When defined, overrides `hidden`
4503
4718
  */
4504
4719
  show_in_table?: boolean;
4720
+ /**
4721
+ * Allow sorting by this attribute in table views if `show_in_table` is true
4722
+ */
4723
+ sortable?: boolean;
4505
4724
  required?: boolean;
4506
4725
  readonly?: boolean;
4507
4726
  deprecated?: boolean;
@@ -4648,6 +4867,10 @@ declare namespace Components {
4648
4867
  * true
4649
4868
  */
4650
4869
  shared?: boolean;
4870
+ /**
4871
+ * List of users (IDs) that have favorited the view
4872
+ */
4873
+ isFavoritedBy?: string[];
4651
4874
  created_by: {
4652
4875
  /**
4653
4876
  * example:
@@ -4717,6 +4940,10 @@ declare namespace Components {
4717
4940
  * true
4718
4941
  */
4719
4942
  shared?: boolean;
4943
+ /**
4944
+ * List of users (IDs) that have favorited the view
4945
+ */
4946
+ isFavoritedBy?: string[];
4720
4947
  created_by: {
4721
4948
  /**
4722
4949
  * example:
@@ -4787,6 +5014,10 @@ declare namespace Components {
4787
5014
  * Render as a column in table views. When defined, overrides `hidden`
4788
5015
  */
4789
5016
  show_in_table?: boolean;
5017
+ /**
5018
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5019
+ */
5020
+ sortable?: boolean;
4790
5021
  required?: boolean;
4791
5022
  readonly?: boolean;
4792
5023
  deprecated?: boolean;
@@ -4915,6 +5146,10 @@ declare namespace Components {
4915
5146
  * Render as a column in table views. When defined, overrides `hidden`
4916
5147
  */
4917
5148
  show_in_table?: boolean;
5149
+ /**
5150
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5151
+ */
5152
+ sortable?: boolean;
4918
5153
  required?: boolean;
4919
5154
  readonly?: boolean;
4920
5155
  deprecated?: boolean;
@@ -5042,6 +5277,10 @@ declare namespace Components {
5042
5277
  * Render as a column in table views. When defined, overrides `hidden`
5043
5278
  */
5044
5279
  show_in_table?: boolean;
5280
+ /**
5281
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5282
+ */
5283
+ sortable?: boolean;
5045
5284
  required?: boolean;
5046
5285
  readonly?: boolean;
5047
5286
  deprecated?: boolean;
@@ -5232,6 +5471,10 @@ declare namespace Components {
5232
5471
  * Render as a column in table views. When defined, overrides `hidden`
5233
5472
  */
5234
5473
  show_in_table?: boolean;
5474
+ /**
5475
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5476
+ */
5477
+ sortable?: boolean;
5235
5478
  required?: boolean;
5236
5479
  readonly?: boolean;
5237
5480
  deprecated?: boolean;
@@ -5393,6 +5636,10 @@ declare namespace Components {
5393
5636
  * Render as a column in table views. When defined, overrides `hidden`
5394
5637
  */
5395
5638
  show_in_table?: boolean;
5639
+ /**
5640
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5641
+ */
5642
+ sortable?: boolean;
5396
5643
  required?: boolean;
5397
5644
  readonly?: boolean;
5398
5645
  deprecated?: boolean;
@@ -5514,6 +5761,10 @@ declare namespace Components {
5514
5761
  * Render as a column in table views. When defined, overrides `hidden`
5515
5762
  */
5516
5763
  show_in_table?: boolean;
5764
+ /**
5765
+ * Allow sorting by this attribute in table views if `show_in_table` is true
5766
+ */
5767
+ sortable?: boolean;
5517
5768
  required?: boolean;
5518
5769
  readonly?: boolean;
5519
5770
  deprecated?: boolean;
@@ -5625,6 +5876,12 @@ declare namespace Components {
5625
5876
  declare namespace Paths {
5626
5877
  namespace AddRelations {
5627
5878
  namespace Parameters {
5879
+ export type ActivityId = /**
5880
+ * See https://github.com/ulid/spec
5881
+ * example:
5882
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
5883
+ */
5884
+ Components.Schemas.ActivityId /* ulid */;
5628
5885
  export type Async = boolean;
5629
5886
  export type Id = Components.Schemas.EntityId /* uuid */;
5630
5887
  export type Slug = /**
@@ -5640,6 +5897,7 @@ declare namespace Paths {
5640
5897
  }
5641
5898
  export interface QueryParameters {
5642
5899
  async?: Parameters.Async;
5900
+ activity_id?: Parameters.ActivityId;
5643
5901
  }
5644
5902
  export type RequestBody = Components.Schemas.RelationItem[];
5645
5903
  namespace Responses {
@@ -5861,6 +6119,12 @@ declare namespace Paths {
5861
6119
  }
5862
6120
  namespace DeleteRelation {
5863
6121
  namespace Parameters {
6122
+ export type ActivityId = /**
6123
+ * See https://github.com/ulid/spec
6124
+ * example:
6125
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
6126
+ */
6127
+ Components.Schemas.ActivityId /* ulid */;
5864
6128
  export type Async = boolean;
5865
6129
  export type Attribute = string;
5866
6130
  export type EntityId = string;
@@ -5880,6 +6144,7 @@ declare namespace Paths {
5880
6144
  }
5881
6145
  export interface QueryParameters {
5882
6146
  async?: Parameters.Async;
6147
+ activity_id?: Parameters.ActivityId;
5883
6148
  }
5884
6149
  namespace Responses {
5885
6150
  export interface $204 {
@@ -6074,6 +6339,7 @@ declare namespace Paths {
6074
6339
  export type Before = string; // date-time
6075
6340
  export type From = number;
6076
6341
  export type Id = Components.Schemas.EntityId /* uuid */;
6342
+ export type IncludeRelations = boolean;
6077
6343
  export type Size = number;
6078
6344
  export type Slug = /**
6079
6345
  * URL-friendly identifier for the entity schema
@@ -6101,6 +6367,7 @@ declare namespace Paths {
6101
6367
  * SyncActivity
6102
6368
  */
6103
6369
  Parameters.Type;
6370
+ include_relations?: Parameters.IncludeRelations;
6104
6371
  }
6105
6372
  namespace Responses {
6106
6373
  export interface $200 {
@@ -6113,11 +6380,47 @@ declare namespace Paths {
6113
6380
  }
6114
6381
  }
6115
6382
  }
6383
+ namespace GetRelatedEntitiesCount {
6384
+ namespace Parameters {
6385
+ export type ExcludeSchemas = string[];
6386
+ export type Id = Components.Schemas.EntityId /* uuid */;
6387
+ export type Slug = /**
6388
+ * URL-friendly identifier for the entity schema
6389
+ * example:
6390
+ * contact
6391
+ */
6392
+ Components.Schemas.EntitySlug;
6393
+ }
6394
+ export interface PathParameters {
6395
+ slug: Parameters.Slug;
6396
+ id: Parameters.Id;
6397
+ }
6398
+ export interface QueryParameters {
6399
+ exclude_schemas?: Parameters.ExcludeSchemas;
6400
+ }
6401
+ namespace Responses {
6402
+ export type $200 = Components.Schemas.GetRelatedEntitiesCount;
6403
+ }
6404
+ }
6116
6405
  namespace GetRelations {
6117
6406
  namespace Parameters {
6407
+ export type ExcludeSchemas = /**
6408
+ * URL-friendly identifier for the entity schema
6409
+ * example:
6410
+ * contact
6411
+ */
6412
+ Components.Schemas.EntitySlug[];
6413
+ export type From = number;
6118
6414
  export type Hydrate = boolean;
6119
6415
  export type Id = Components.Schemas.EntityId /* uuid */;
6120
6416
  export type IncludeReverse = boolean;
6417
+ export type IncludeSchemas = /**
6418
+ * URL-friendly identifier for the entity schema
6419
+ * example:
6420
+ * contact
6421
+ */
6422
+ Components.Schemas.EntitySlug[];
6423
+ export type Size = number;
6121
6424
  export type Slug = /**
6122
6425
  * URL-friendly identifier for the entity schema
6123
6426
  * example:
@@ -6132,9 +6435,13 @@ declare namespace Paths {
6132
6435
  export interface QueryParameters {
6133
6436
  hydrate?: Parameters.Hydrate;
6134
6437
  include_reverse?: Parameters.IncludeReverse;
6438
+ from?: Parameters.From;
6439
+ size?: Parameters.Size;
6440
+ include_schemas?: Parameters.IncludeSchemas;
6441
+ exclude_schemas?: Parameters.ExcludeSchemas;
6135
6442
  }
6136
6443
  namespace Responses {
6137
- export type $200 = Components.Schemas.GetRelationsResp;
6444
+ export type $200 = Components.Schemas.GetRelationsRespWithPagination;
6138
6445
  }
6139
6446
  }
6140
6447
  namespace GetRelationsV2 {
@@ -6281,6 +6588,13 @@ declare namespace Paths {
6281
6588
  }
6282
6589
  }
6283
6590
  }
6591
+ namespace ListFavoriteViewsForUser {
6592
+ namespace Responses {
6593
+ export interface $200 {
6594
+ results?: /* A saved entity view */ Components.Schemas.SavedViewItem[];
6595
+ }
6596
+ }
6597
+ }
6284
6598
  namespace ListSavedViews {
6285
6599
  namespace Responses {
6286
6600
  export interface $200 {
@@ -6640,6 +6954,12 @@ declare namespace Paths {
6640
6954
  }
6641
6955
  namespace UpdateRelation {
6642
6956
  namespace Parameters {
6957
+ export type ActivityId = /**
6958
+ * See https://github.com/ulid/spec
6959
+ * example:
6960
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
6961
+ */
6962
+ Components.Schemas.ActivityId /* ulid */;
6643
6963
  export type Async = boolean;
6644
6964
  export type Attribute = string;
6645
6965
  export type EntityId = string;
@@ -6659,6 +6979,7 @@ declare namespace Paths {
6659
6979
  }
6660
6980
  export interface QueryParameters {
6661
6981
  async?: Parameters.Async;
6982
+ activity_id?: Parameters.ActivityId;
6662
6983
  }
6663
6984
  export interface RequestBody {
6664
6985
  _tags?: string[];
@@ -7295,6 +7616,17 @@ export interface OperationMethods {
7295
7616
  data?: any,
7296
7617
  config?: AxiosRequestConfig
7297
7618
  ): OperationResponse<Paths.GetRelationsV2.Responses.$200>
7619
+ /**
7620
+ * getRelatedEntitiesCount - getRelatedEntitiesCount
7621
+ *
7622
+ * Returns the amount of unique related entities for an entity - includes direct and reverse relations.
7623
+ *
7624
+ */
7625
+ 'getRelatedEntitiesCount'(
7626
+ parameters?: Parameters<Paths.GetRelatedEntitiesCount.PathParameters & Paths.GetRelatedEntitiesCount.QueryParameters> | null,
7627
+ data?: any,
7628
+ config?: AxiosRequestConfig
7629
+ ): OperationResponse<Paths.GetRelatedEntitiesCount.Responses.$200>
7298
7630
  /**
7299
7631
  * updateRelation - updateRelation
7300
7632
  *
@@ -7388,6 +7720,16 @@ export interface OperationMethods {
7388
7720
  data?: any,
7389
7721
  config?: AxiosRequestConfig
7390
7722
  ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
7723
+ /**
7724
+ * listFavoriteViewsForUser - listFavoriteViewsForUser
7725
+ *
7726
+ * Get the Favorite Saved Views for user based on the schema
7727
+ */
7728
+ 'listFavoriteViewsForUser'(
7729
+ parameters?: Parameters<UnknownParamsObject> | null,
7730
+ data?: any,
7731
+ config?: AxiosRequestConfig
7732
+ ): OperationResponse<Paths.ListFavoriteViewsForUser.Responses.$200>
7391
7733
  /**
7392
7734
  * listTaxonomies - listTaxonomies
7393
7735
  *
@@ -7928,6 +8270,19 @@ export interface PathsDictionary {
7928
8270
  config?: AxiosRequestConfig
7929
8271
  ): OperationResponse<Paths.GetRelationsV2.Responses.$200>
7930
8272
  }
8273
+ ['/v2/entity/{slug}/{id}/relations/count']: {
8274
+ /**
8275
+ * getRelatedEntitiesCount - getRelatedEntitiesCount
8276
+ *
8277
+ * Returns the amount of unique related entities for an entity - includes direct and reverse relations.
8278
+ *
8279
+ */
8280
+ 'get'(
8281
+ parameters?: Parameters<Paths.GetRelatedEntitiesCount.PathParameters & Paths.GetRelatedEntitiesCount.QueryParameters> | null,
8282
+ data?: any,
8283
+ config?: AxiosRequestConfig
8284
+ ): OperationResponse<Paths.GetRelatedEntitiesCount.Responses.$200>
8285
+ }
7931
8286
  ['/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}']: {
7932
8287
  /**
7933
8288
  * updateRelation - updateRelation
@@ -8033,6 +8388,18 @@ export interface PathsDictionary {
8033
8388
  config?: AxiosRequestConfig
8034
8389
  ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
8035
8390
  }
8391
+ ['/v1/entity/views/favorites']: {
8392
+ /**
8393
+ * listFavoriteViewsForUser - listFavoriteViewsForUser
8394
+ *
8395
+ * Get the Favorite Saved Views for user based on the schema
8396
+ */
8397
+ 'get'(
8398
+ parameters?: Parameters<UnknownParamsObject> | null,
8399
+ data?: any,
8400
+ config?: AxiosRequestConfig
8401
+ ): OperationResponse<Paths.ListFavoriteViewsForUser.Responses.$200>
8402
+ }
8036
8403
  ['/v1/entity/listTaxonomies']: {
8037
8404
  /**
8038
8405
  * listTaxonomies - listTaxonomies
package/dist/openapi.json CHANGED
@@ -1237,6 +1237,56 @@
1237
1237
  "default": false,
1238
1238
  "type": "boolean"
1239
1239
  }
1240
+ },
1241
+ {
1242
+ "in": "query",
1243
+ "name": "from",
1244
+ "description": "Starting page number",
1245
+ "schema": {
1246
+ "type": "integer",
1247
+ "minimum": 0,
1248
+ "default": 0
1249
+ }
1250
+ },
1251
+ {
1252
+ "in": "query",
1253
+ "name": "size",
1254
+ "description": "Number of results to return per page",
1255
+ "required": false,
1256
+ "schema": {
1257
+ "type": "integer",
1258
+ "minimum": 1,
1259
+ "maximum": 1000,
1260
+ "default": 100
1261
+ }
1262
+ },
1263
+ {
1264
+ "in": "query",
1265
+ "name": "include_schemas",
1266
+ "description": "Filter results to only include schemas",
1267
+ "required": false,
1268
+ "style": "form",
1269
+ "explode": false,
1270
+ "schema": {
1271
+ "type": "array",
1272
+ "items": {
1273
+ "$ref": "#/components/schemas/EntitySlug"
1274
+ }
1275
+ }
1276
+ },
1277
+ {
1278
+ "in": "query",
1279
+ "name": "exclude_schemas",
1280
+ "description": "Filter results to exclude schemas",
1281
+ "required": false,
1282
+ "style": "form",
1283
+ "explode": false,
1284
+ "schema": {
1285
+ "type": "array",
1286
+ "items": {
1287
+ "$ref": "#/components/schemas/EntitySlug"
1288
+ }
1289
+ }
1240
1290
  }
1241
1291
  ],
1242
1292
  "responses": {
@@ -1245,7 +1295,7 @@
1245
1295
  "content": {
1246
1296
  "application/json": {
1247
1297
  "schema": {
1248
- "$ref": "#/components/schemas/GetRelationsResp"
1298
+ "$ref": "#/components/schemas/GetRelationsRespWithPagination"
1249
1299
  },
1250
1300
  "example": [
1251
1301
  {
@@ -1322,6 +1372,15 @@
1322
1372
  "type": "boolean",
1323
1373
  "default": false
1324
1374
  }
1375
+ },
1376
+ {
1377
+ "in": "query",
1378
+ "name": "activity_id",
1379
+ "description": "Activity to include in event feed",
1380
+ "required": false,
1381
+ "schema": {
1382
+ "$ref": "#/components/schemas/ActivityId"
1383
+ }
1325
1384
  }
1326
1385
  ],
1327
1386
  "requestBody": {
@@ -1471,6 +1530,63 @@
1471
1530
  }
1472
1531
  }
1473
1532
  },
1533
+ "/v2/entity/{slug}/{id}/relations/count": {
1534
+ "get": {
1535
+ "operationId": "getRelatedEntitiesCount",
1536
+ "summary": "getRelatedEntitiesCount",
1537
+ "description": "Returns the amount of unique related entities for an entity - includes direct and reverse relations.\n",
1538
+ "tags": [
1539
+ "Relations"
1540
+ ],
1541
+ "parameters": [
1542
+ {
1543
+ "in": "path",
1544
+ "name": "slug",
1545
+ "description": "Entity Schema",
1546
+ "required": true,
1547
+ "schema": {
1548
+ "$ref": "#/components/schemas/EntitySlug"
1549
+ }
1550
+ },
1551
+ {
1552
+ "in": "path",
1553
+ "name": "id",
1554
+ "description": "Entity id",
1555
+ "required": true,
1556
+ "schema": {
1557
+ "$ref": "#/components/schemas/EntityId"
1558
+ }
1559
+ },
1560
+ {
1561
+ "in": "query",
1562
+ "name": "exclude_schemas",
1563
+ "description": "To be excluded from the count by given schemas",
1564
+ "required": false,
1565
+ "style": "form",
1566
+ "example": "<url>/count?exclude_schemas=file,message",
1567
+ "explode": false,
1568
+ "schema": {
1569
+ "type": "array",
1570
+ "items": {
1571
+ "type": "string"
1572
+ }
1573
+ }
1574
+ }
1575
+ ],
1576
+ "responses": {
1577
+ "200": {
1578
+ "description": "Success",
1579
+ "content": {
1580
+ "application/json": {
1581
+ "schema": {
1582
+ "$ref": "#/components/schemas/GetRelatedEntitiesCount"
1583
+ }
1584
+ }
1585
+ }
1586
+ }
1587
+ }
1588
+ }
1589
+ },
1474
1590
  "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
1475
1591
  "put": {
1476
1592
  "operationId": "updateRelation",
@@ -1525,6 +1641,15 @@
1525
1641
  "type": "boolean",
1526
1642
  "default": false
1527
1643
  }
1644
+ },
1645
+ {
1646
+ "in": "query",
1647
+ "name": "activity_id",
1648
+ "description": "Activity to include in event feed",
1649
+ "required": false,
1650
+ "schema": {
1651
+ "$ref": "#/components/schemas/ActivityId"
1652
+ }
1528
1653
  }
1529
1654
  ],
1530
1655
  "requestBody": {
@@ -1616,6 +1741,15 @@
1616
1741
  "type": "boolean",
1617
1742
  "default": false
1618
1743
  }
1744
+ },
1745
+ {
1746
+ "in": "query",
1747
+ "name": "activity_id",
1748
+ "description": "Activity to include in event feed",
1749
+ "required": false,
1750
+ "schema": {
1751
+ "$ref": "#/components/schemas/ActivityId"
1752
+ }
1619
1753
  }
1620
1754
  ],
1621
1755
  "responses": {
@@ -1872,6 +2006,36 @@
1872
2006
  }
1873
2007
  }
1874
2008
  },
2009
+ "/v1/entity/views/favorites": {
2010
+ "get": {
2011
+ "operationId": "listFavoriteViewsForUser",
2012
+ "summary": "listFavoriteViewsForUser",
2013
+ "description": "Get the Favorite Saved Views for user based on the schema",
2014
+ "tags": [
2015
+ "Saved Views"
2016
+ ],
2017
+ "responses": {
2018
+ "200": {
2019
+ "description": "Success",
2020
+ "content": {
2021
+ "application/json": {
2022
+ "schema": {
2023
+ "type": "object",
2024
+ "properties": {
2025
+ "results": {
2026
+ "type": "array",
2027
+ "items": {
2028
+ "$ref": "#/components/schemas/SavedViewItem"
2029
+ }
2030
+ }
2031
+ }
2032
+ }
2033
+ }
2034
+ }
2035
+ }
2036
+ }
2037
+ }
2038
+ },
1875
2039
  "/v1/entity/listTaxonomies": {
1876
2040
  "get": {
1877
2041
  "operationId": "listTaxonomies",
@@ -2567,6 +2731,9 @@
2567
2731
  },
2568
2732
  {
2569
2733
  "$ref": "#/components/schemas/PurposeAttribute"
2734
+ },
2735
+ {
2736
+ "$ref": "#/components/schemas/PartnerOrganisationAttribute"
2570
2737
  }
2571
2738
  ]
2572
2739
  },
@@ -2591,6 +2758,11 @@
2591
2758
  "description": "Render as a column in table views. When defined, overrides `hidden`",
2592
2759
  "type": "boolean"
2593
2760
  },
2761
+ "sortable": {
2762
+ "description": "Allow sorting by this attribute in table views if `show_in_table` is true",
2763
+ "type": "boolean",
2764
+ "default": true
2765
+ },
2594
2766
  "required": {
2595
2767
  "type": "boolean",
2596
2768
  "default": false
@@ -3314,6 +3486,25 @@
3314
3486
  }
3315
3487
  ]
3316
3488
  },
3489
+ "PartnerOrganisationAttribute": {
3490
+ "allOf": [
3491
+ {
3492
+ "$ref": "#/components/schemas/BaseAttribute"
3493
+ },
3494
+ {
3495
+ "type": "object",
3496
+ "description": "Shared Partner Organisations",
3497
+ "properties": {
3498
+ "type": {
3499
+ "type": "string",
3500
+ "enum": [
3501
+ "partner_organisation"
3502
+ ]
3503
+ }
3504
+ }
3505
+ }
3506
+ ]
3507
+ },
3317
3508
  "AddressRelationAttribute": {
3318
3509
  "allOf": [
3319
3510
  {
@@ -4268,6 +4459,15 @@
4268
4459
  }
4269
4460
  }
4270
4461
  },
4462
+ "GetRelatedEntitiesCount": {
4463
+ "type": "object",
4464
+ "properties": {
4465
+ "hits": {
4466
+ "type": "integer",
4467
+ "example": 1
4468
+ }
4469
+ }
4470
+ },
4271
4471
  "RelationEntity": {
4272
4472
  "allOf": [
4273
4473
  {
@@ -4739,6 +4939,14 @@
4739
4939
  "type": "boolean",
4740
4940
  "example": true
4741
4941
  },
4942
+ "isFavoritedBy": {
4943
+ "description": "List of users (IDs) that have favorited the view",
4944
+ "type": "array",
4945
+ "items": {
4946
+ "type": "string",
4947
+ "example": 11701
4948
+ }
4949
+ },
4742
4950
  "created_by": {
4743
4951
  "anyOf": [
4744
4952
  {
File without changes
File without changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "4.15.3",
3
+ "version": "4.15.4",
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",