@epilot/entity-client 4.15.0-rc1 → 4.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/openapi.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,48 @@
1471
1480
  }
1472
1481
  }
1473
1482
  },
1483
+ "/v2/entity/{slug}/{id}/relations/count": {
1484
+ "get": {
1485
+ "operationId": "getRelatedEntitiesCountByEntityId",
1486
+ "summary": "getRelatedEntitiesCountByEntityId",
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 Type",
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
+ "responses": {
1512
+ "200": {
1513
+ "description": "Success",
1514
+ "content": {
1515
+ "application/json": {
1516
+ "schema": {
1517
+ "$ref": "#/components/schemas/GetRelatedEntitiesCount"
1518
+ }
1519
+ }
1520
+ }
1521
+ }
1522
+ }
1523
+ }
1524
+ },
1474
1525
  "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}": {
1475
1526
  "put": {
1476
1527
  "operationId": "updateRelation",
@@ -1525,6 +1576,15 @@
1525
1576
  "type": "boolean",
1526
1577
  "default": false
1527
1578
  }
1579
+ },
1580
+ {
1581
+ "in": "query",
1582
+ "name": "activity_id",
1583
+ "description": "Activity to include in event feed",
1584
+ "required": false,
1585
+ "schema": {
1586
+ "$ref": "#/components/schemas/ActivityId"
1587
+ }
1528
1588
  }
1529
1589
  ],
1530
1590
  "requestBody": {
@@ -1616,6 +1676,15 @@
1616
1676
  "type": "boolean",
1617
1677
  "default": false
1618
1678
  }
1679
+ },
1680
+ {
1681
+ "in": "query",
1682
+ "name": "activity_id",
1683
+ "description": "Activity to include in event feed",
1684
+ "required": false,
1685
+ "schema": {
1686
+ "$ref": "#/components/schemas/ActivityId"
1687
+ }
1619
1688
  }
1620
1689
  ],
1621
1690
  "responses": {
@@ -1872,6 +1941,36 @@
1872
1941
  }
1873
1942
  }
1874
1943
  },
1944
+ "/v1/entity/views/favorites": {
1945
+ "get": {
1946
+ "operationId": "listFavoriteViewsForUser",
1947
+ "summary": "listFavoriteViewsForUser",
1948
+ "description": "Get the Favorite Saved Views for user based on the schema",
1949
+ "tags": [
1950
+ "Saved Views"
1951
+ ],
1952
+ "responses": {
1953
+ "200": {
1954
+ "description": "Success",
1955
+ "content": {
1956
+ "application/json": {
1957
+ "schema": {
1958
+ "type": "object",
1959
+ "properties": {
1960
+ "results": {
1961
+ "type": "array",
1962
+ "items": {
1963
+ "$ref": "#/components/schemas/SavedViewItem"
1964
+ }
1965
+ }
1966
+ }
1967
+ }
1968
+ }
1969
+ }
1970
+ }
1971
+ }
1972
+ }
1973
+ },
1875
1974
  "/v1/entity/listTaxonomies": {
1876
1975
  "get": {
1877
1976
  "operationId": "listTaxonomies",
@@ -2567,6 +2666,9 @@
2567
2666
  },
2568
2667
  {
2569
2668
  "$ref": "#/components/schemas/PurposeAttribute"
2669
+ },
2670
+ {
2671
+ "$ref": "#/components/schemas/PartnerOrganisationAttribute"
2570
2672
  }
2571
2673
  ]
2572
2674
  },
@@ -2591,6 +2693,11 @@
2591
2693
  "description": "Render as a column in table views. When defined, overrides `hidden`",
2592
2694
  "type": "boolean"
2593
2695
  },
2696
+ "sortable": {
2697
+ "description": "Allow sorting by this attribute in table views if `show_in_table` is true",
2698
+ "type": "boolean",
2699
+ "default": true
2700
+ },
2594
2701
  "required": {
2595
2702
  "type": "boolean",
2596
2703
  "default": false
@@ -3314,6 +3421,25 @@
3314
3421
  }
3315
3422
  ]
3316
3423
  },
3424
+ "PartnerOrganisationAttribute": {
3425
+ "allOf": [
3426
+ {
3427
+ "$ref": "#/components/schemas/BaseAttribute"
3428
+ },
3429
+ {
3430
+ "type": "object",
3431
+ "description": "Shared Partner Organisations",
3432
+ "properties": {
3433
+ "type": {
3434
+ "type": "string",
3435
+ "enum": [
3436
+ "partner_organisation"
3437
+ ]
3438
+ }
3439
+ }
3440
+ }
3441
+ ]
3442
+ },
3317
3443
  "AddressRelationAttribute": {
3318
3444
  "allOf": [
3319
3445
  {
@@ -4268,6 +4394,15 @@
4268
4394
  }
4269
4395
  }
4270
4396
  },
4397
+ "GetRelatedEntitiesCount": {
4398
+ "type": "object",
4399
+ "properties": {
4400
+ "hits": {
4401
+ "type": "number",
4402
+ "example": 1
4403
+ }
4404
+ }
4405
+ },
4271
4406
  "RelationEntity": {
4272
4407
  "allOf": [
4273
4408
  {
@@ -4739,6 +4874,14 @@
4739
4874
  "type": "boolean",
4740
4875
  "example": true
4741
4876
  },
4877
+ "isFavoritedBy": {
4878
+ "description": "List of users (IDs) that have favorited the view",
4879
+ "type": "array",
4880
+ "items": {
4881
+ "type": "string",
4882
+ "example": 11701
4883
+ }
4884
+ },
4742
4885
  "created_by": {
4743
4886
  "anyOf": [
4744
4887
  {
File without changes
File without changes