@epilot/entity-client 4.16.0-rc3 → 4.16.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/definition.js +1 -1
- package/dist/openapi-runtime.json +71 -0
- package/dist/openapi.d.ts +92 -16
- package/dist/openapi.json +160 -13
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -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},{"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})})();
|
|
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"}]}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","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}]}},"/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})})();
|
|
@@ -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
|
},
|
|
@@ -512,6 +535,54 @@
|
|
|
512
535
|
]
|
|
513
536
|
}
|
|
514
537
|
},
|
|
538
|
+
"/v3/entity/{slug}/{id}/relations": {
|
|
539
|
+
"get": {
|
|
540
|
+
"operationId": "getRelationsV3",
|
|
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": "hydrate"
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
"in": "query",
|
|
558
|
+
"name": "include_reverse"
|
|
559
|
+
},
|
|
560
|
+
{
|
|
561
|
+
"in": "query",
|
|
562
|
+
"name": "from"
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"in": "query",
|
|
566
|
+
"name": "size",
|
|
567
|
+
"required": false
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
"in": "query",
|
|
571
|
+
"name": "include_schemas",
|
|
572
|
+
"required": false,
|
|
573
|
+
"style": "form",
|
|
574
|
+
"explode": false
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
"in": "query",
|
|
578
|
+
"name": "exclude_schemas",
|
|
579
|
+
"required": false,
|
|
580
|
+
"style": "form",
|
|
581
|
+
"explode": false
|
|
582
|
+
}
|
|
583
|
+
]
|
|
584
|
+
}
|
|
585
|
+
},
|
|
515
586
|
"/v2/entity/{slug}/{id}/relations/count": {
|
|
516
587
|
"get": {
|
|
517
588
|
"operationId": "getRelatedEntitiesCount",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -2020,14 +2020,6 @@ declare namespace Components {
|
|
|
2020
2020
|
* }
|
|
2021
2021
|
*/
|
|
2022
2022
|
RedirectEntityView | EntityViewDisabled;
|
|
2023
|
-
single_view?: EntityDefaultEdit | /**
|
|
2024
|
-
* example:
|
|
2025
|
-
* {
|
|
2026
|
-
* "type": "redirect",
|
|
2027
|
-
* "route": "/app/pricing-hub/product/:entityId"
|
|
2028
|
-
* }
|
|
2029
|
-
*/
|
|
2030
|
-
RedirectEntityView | EntityViewDisabled;
|
|
2031
2023
|
list_item?: {
|
|
2032
2024
|
summary_attributes?: (/**
|
|
2033
2025
|
* Represents an expanded version of an attribute to be displayed in the list item summary.
|
|
@@ -2277,14 +2269,6 @@ declare namespace Components {
|
|
|
2277
2269
|
* }
|
|
2278
2270
|
*/
|
|
2279
2271
|
RedirectEntityView | EntityViewDisabled;
|
|
2280
|
-
single_view?: EntityDefaultEdit | /**
|
|
2281
|
-
* example:
|
|
2282
|
-
* {
|
|
2283
|
-
* "type": "redirect",
|
|
2284
|
-
* "route": "/app/pricing-hub/product/:entityId"
|
|
2285
|
-
* }
|
|
2286
|
-
*/
|
|
2287
|
-
RedirectEntityView | EntityViewDisabled;
|
|
2288
2272
|
list_item?: {
|
|
2289
2273
|
summary_attributes?: (/**
|
|
2290
2274
|
* Represents an expanded version of an attribute to be displayed in the list item summary.
|
|
@@ -6435,9 +6419,23 @@ declare namespace Paths {
|
|
|
6435
6419
|
}
|
|
6436
6420
|
namespace GetRelations {
|
|
6437
6421
|
namespace Parameters {
|
|
6422
|
+
export type ExcludeSchemas = /**
|
|
6423
|
+
* URL-friendly identifier for the entity schema
|
|
6424
|
+
* example:
|
|
6425
|
+
* contact
|
|
6426
|
+
*/
|
|
6427
|
+
Components.Schemas.EntitySlug[];
|
|
6428
|
+
export type From = number;
|
|
6438
6429
|
export type Hydrate = boolean;
|
|
6439
6430
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
6440
6431
|
export type IncludeReverse = boolean;
|
|
6432
|
+
export type IncludeSchemas = /**
|
|
6433
|
+
* URL-friendly identifier for the entity schema
|
|
6434
|
+
* example:
|
|
6435
|
+
* contact
|
|
6436
|
+
*/
|
|
6437
|
+
Components.Schemas.EntitySlug[];
|
|
6438
|
+
export type Size = number;
|
|
6441
6439
|
export type Slug = /**
|
|
6442
6440
|
* URL-friendly identifier for the entity schema
|
|
6443
6441
|
* example:
|
|
@@ -6452,6 +6450,10 @@ declare namespace Paths {
|
|
|
6452
6450
|
export interface QueryParameters {
|
|
6453
6451
|
hydrate?: Parameters.Hydrate;
|
|
6454
6452
|
include_reverse?: Parameters.IncludeReverse;
|
|
6453
|
+
from?: Parameters.From;
|
|
6454
|
+
size?: Parameters.Size;
|
|
6455
|
+
include_schemas?: Parameters.IncludeSchemas;
|
|
6456
|
+
exclude_schemas?: Parameters.ExcludeSchemas;
|
|
6455
6457
|
}
|
|
6456
6458
|
namespace Responses {
|
|
6457
6459
|
export type $200 = Components.Schemas.GetRelationsResp;
|
|
@@ -6505,6 +6507,48 @@ declare namespace Paths {
|
|
|
6505
6507
|
export type $200 = Components.Schemas.GetRelationsRespWithPagination;
|
|
6506
6508
|
}
|
|
6507
6509
|
}
|
|
6510
|
+
namespace GetRelationsV3 {
|
|
6511
|
+
namespace Parameters {
|
|
6512
|
+
export type ExcludeSchemas = /**
|
|
6513
|
+
* URL-friendly identifier for the entity schema
|
|
6514
|
+
* example:
|
|
6515
|
+
* contact
|
|
6516
|
+
*/
|
|
6517
|
+
Components.Schemas.EntitySlug[];
|
|
6518
|
+
export type From = number;
|
|
6519
|
+
export type Hydrate = boolean;
|
|
6520
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
6521
|
+
export type IncludeReverse = boolean;
|
|
6522
|
+
export type IncludeSchemas = /**
|
|
6523
|
+
* URL-friendly identifier for the entity schema
|
|
6524
|
+
* example:
|
|
6525
|
+
* contact
|
|
6526
|
+
*/
|
|
6527
|
+
Components.Schemas.EntitySlug[];
|
|
6528
|
+
export type Size = number;
|
|
6529
|
+
export type Slug = /**
|
|
6530
|
+
* URL-friendly identifier for the entity schema
|
|
6531
|
+
* example:
|
|
6532
|
+
* contact
|
|
6533
|
+
*/
|
|
6534
|
+
Components.Schemas.EntitySlug;
|
|
6535
|
+
}
|
|
6536
|
+
export interface PathParameters {
|
|
6537
|
+
slug: Parameters.Slug;
|
|
6538
|
+
id: Parameters.Id;
|
|
6539
|
+
}
|
|
6540
|
+
export interface QueryParameters {
|
|
6541
|
+
hydrate?: Parameters.Hydrate;
|
|
6542
|
+
include_reverse?: Parameters.IncludeReverse;
|
|
6543
|
+
from?: Parameters.From;
|
|
6544
|
+
size?: Parameters.Size;
|
|
6545
|
+
include_schemas?: Parameters.IncludeSchemas;
|
|
6546
|
+
exclude_schemas?: Parameters.ExcludeSchemas;
|
|
6547
|
+
}
|
|
6548
|
+
namespace Responses {
|
|
6549
|
+
export type $200 = Components.Schemas.GetRelationsRespWithPagination;
|
|
6550
|
+
}
|
|
6551
|
+
}
|
|
6508
6552
|
namespace GetSavedView {
|
|
6509
6553
|
namespace Parameters {
|
|
6510
6554
|
export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
|
|
@@ -7629,6 +7673,21 @@ export interface OperationMethods {
|
|
|
7629
7673
|
data?: any,
|
|
7630
7674
|
config?: AxiosRequestConfig
|
|
7631
7675
|
): OperationResponse<Paths.GetRelationsV2.Responses.$200>
|
|
7676
|
+
/**
|
|
7677
|
+
* getRelationsV3 - getRelationsV3
|
|
7678
|
+
*
|
|
7679
|
+
* Returns 1st level direct relations for an entity with pagination.
|
|
7680
|
+
*
|
|
7681
|
+
* You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
|
|
7682
|
+
*
|
|
7683
|
+
* Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
|
|
7684
|
+
*
|
|
7685
|
+
*/
|
|
7686
|
+
'getRelationsV3'(
|
|
7687
|
+
parameters?: Parameters<Paths.GetRelationsV3.PathParameters & Paths.GetRelationsV3.QueryParameters> | null,
|
|
7688
|
+
data?: any,
|
|
7689
|
+
config?: AxiosRequestConfig
|
|
7690
|
+
): OperationResponse<Paths.GetRelationsV3.Responses.$200>
|
|
7632
7691
|
/**
|
|
7633
7692
|
* getRelatedEntitiesCount - getRelatedEntitiesCount
|
|
7634
7693
|
*
|
|
@@ -8283,6 +8342,23 @@ export interface PathsDictionary {
|
|
|
8283
8342
|
config?: AxiosRequestConfig
|
|
8284
8343
|
): OperationResponse<Paths.GetRelationsV2.Responses.$200>
|
|
8285
8344
|
}
|
|
8345
|
+
['/v3/entity/{slug}/{id}/relations']: {
|
|
8346
|
+
/**
|
|
8347
|
+
* getRelationsV3 - getRelationsV3
|
|
8348
|
+
*
|
|
8349
|
+
* Returns 1st level direct relations for an entity with pagination.
|
|
8350
|
+
*
|
|
8351
|
+
* You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
|
|
8352
|
+
*
|
|
8353
|
+
* Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
|
|
8354
|
+
*
|
|
8355
|
+
*/
|
|
8356
|
+
'get'(
|
|
8357
|
+
parameters?: Parameters<Paths.GetRelationsV3.PathParameters & Paths.GetRelationsV3.QueryParameters> | null,
|
|
8358
|
+
data?: any,
|
|
8359
|
+
config?: AxiosRequestConfig
|
|
8360
|
+
): OperationResponse<Paths.GetRelationsV3.Responses.$200>
|
|
8361
|
+
}
|
|
8286
8362
|
['/v2/entity/{slug}/{id}/relations/count']: {
|
|
8287
8363
|
/**
|
|
8288
8364
|
* getRelatedEntitiesCount - getRelatedEntitiesCount
|
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": {
|
|
@@ -1480,6 +1530,116 @@
|
|
|
1480
1530
|
}
|
|
1481
1531
|
}
|
|
1482
1532
|
},
|
|
1533
|
+
"/v3/entity/{slug}/{id}/relations": {
|
|
1534
|
+
"get": {
|
|
1535
|
+
"operationId": "getRelationsV3",
|
|
1536
|
+
"summary": "getRelationsV3",
|
|
1537
|
+
"description": "Returns 1st level direct relations for an entity with pagination.\n\nYou can control whether to return the full entity or just the relation item with the `?hydrate` query param.\n\nReverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.\n",
|
|
1538
|
+
"tags": [
|
|
1539
|
+
"Relations"
|
|
1540
|
+
],
|
|
1541
|
+
"parameters": [
|
|
1542
|
+
{
|
|
1543
|
+
"in": "path",
|
|
1544
|
+
"name": "slug",
|
|
1545
|
+
"description": "Entity Type",
|
|
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": "hydrate",
|
|
1563
|
+
"description": "When true, expand relation items with full blown entities.",
|
|
1564
|
+
"schema": {
|
|
1565
|
+
"default": false,
|
|
1566
|
+
"type": "boolean"
|
|
1567
|
+
}
|
|
1568
|
+
},
|
|
1569
|
+
{
|
|
1570
|
+
"in": "query",
|
|
1571
|
+
"name": "include_reverse",
|
|
1572
|
+
"description": "When true, includes reverse relations in response (other entities pointing to this entity)",
|
|
1573
|
+
"schema": {
|
|
1574
|
+
"default": false,
|
|
1575
|
+
"type": "boolean"
|
|
1576
|
+
}
|
|
1577
|
+
},
|
|
1578
|
+
{
|
|
1579
|
+
"in": "query",
|
|
1580
|
+
"name": "from",
|
|
1581
|
+
"description": "Starting page number",
|
|
1582
|
+
"schema": {
|
|
1583
|
+
"type": "integer",
|
|
1584
|
+
"minimum": 0,
|
|
1585
|
+
"default": 0
|
|
1586
|
+
}
|
|
1587
|
+
},
|
|
1588
|
+
{
|
|
1589
|
+
"in": "query",
|
|
1590
|
+
"name": "size",
|
|
1591
|
+
"description": "Number of results to return per page",
|
|
1592
|
+
"required": false,
|
|
1593
|
+
"schema": {
|
|
1594
|
+
"type": "integer",
|
|
1595
|
+
"minimum": 1,
|
|
1596
|
+
"maximum": 1000,
|
|
1597
|
+
"default": 100
|
|
1598
|
+
}
|
|
1599
|
+
},
|
|
1600
|
+
{
|
|
1601
|
+
"in": "query",
|
|
1602
|
+
"name": "include_schemas",
|
|
1603
|
+
"description": "Filter results to only include schemas",
|
|
1604
|
+
"required": false,
|
|
1605
|
+
"style": "form",
|
|
1606
|
+
"explode": false,
|
|
1607
|
+
"schema": {
|
|
1608
|
+
"type": "array",
|
|
1609
|
+
"items": {
|
|
1610
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1611
|
+
}
|
|
1612
|
+
}
|
|
1613
|
+
},
|
|
1614
|
+
{
|
|
1615
|
+
"in": "query",
|
|
1616
|
+
"name": "exclude_schemas",
|
|
1617
|
+
"description": "Filter results to exclude schemas",
|
|
1618
|
+
"required": false,
|
|
1619
|
+
"style": "form",
|
|
1620
|
+
"explode": false,
|
|
1621
|
+
"schema": {
|
|
1622
|
+
"type": "array",
|
|
1623
|
+
"items": {
|
|
1624
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1625
|
+
}
|
|
1626
|
+
}
|
|
1627
|
+
}
|
|
1628
|
+
],
|
|
1629
|
+
"responses": {
|
|
1630
|
+
"200": {
|
|
1631
|
+
"description": "Success",
|
|
1632
|
+
"content": {
|
|
1633
|
+
"application/json": {
|
|
1634
|
+
"schema": {
|
|
1635
|
+
"$ref": "#/components/schemas/GetRelationsRespWithPagination"
|
|
1636
|
+
}
|
|
1637
|
+
}
|
|
1638
|
+
}
|
|
1639
|
+
}
|
|
1640
|
+
}
|
|
1641
|
+
}
|
|
1642
|
+
},
|
|
1483
1643
|
"/v2/entity/{slug}/{id}/relations/count": {
|
|
1484
1644
|
"get": {
|
|
1485
1645
|
"operationId": "getRelatedEntitiesCount",
|
|
@@ -2356,19 +2516,6 @@
|
|
|
2356
2516
|
}
|
|
2357
2517
|
]
|
|
2358
2518
|
},
|
|
2359
|
-
"single_view": {
|
|
2360
|
-
"anyOf": [
|
|
2361
|
-
{
|
|
2362
|
-
"$ref": "#/components/schemas/EntityDefaultEdit"
|
|
2363
|
-
},
|
|
2364
|
-
{
|
|
2365
|
-
"$ref": "#/components/schemas/RedirectEntityView"
|
|
2366
|
-
},
|
|
2367
|
-
{
|
|
2368
|
-
"$ref": "#/components/schemas/EntityViewDisabled"
|
|
2369
|
-
}
|
|
2370
|
-
]
|
|
2371
|
-
},
|
|
2372
2519
|
"list_item": {
|
|
2373
2520
|
"type": "object",
|
|
2374
2521
|
"properties": {
|