@epilot/entity-client 4.18.1 → 4.19.0-rc.1
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 +30 -1
- package/dist/openapi.d.ts +159 -20
- package/dist/openapi.json +83 -19
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={914:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(240));t.default=n.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":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}]},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"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":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"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":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}]},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}]}},"/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":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}]}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}]}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}]},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}]}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"}]}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}]}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}]}},"/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":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser"}},"/v1/entity/listTaxonomies":{"get":{"operationId":"listTaxonomies"}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}]}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"$ref":"#/components/parameters/TaxonomySlugQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,a),o.exports}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={914:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(240));t.default=n.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":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}]},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"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":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"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":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}]}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}]},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}]}},"/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":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}]}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}]}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}]},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}]}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"}]}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}]}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}]}},"/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","parameters":[{"in":"query","name":"slug","required":false}]}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser"}},"/v1/entity/listTaxonomies":{"get":{"operationId":"listTaxonomies"}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}]}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"$ref":"#/components/parameters/TaxonomySlugQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,a),o.exports}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
@@ -162,6 +162,28 @@
|
|
|
162
162
|
}
|
|
163
163
|
}
|
|
164
164
|
},
|
|
165
|
+
"/v2/entity/{slug}/{id}": {
|
|
166
|
+
"get": {
|
|
167
|
+
"operationId": "getEntityV2",
|
|
168
|
+
"parameters": [
|
|
169
|
+
{
|
|
170
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
171
|
+
},
|
|
172
|
+
{
|
|
173
|
+
"$ref": "#/components/parameters/EntitySlugPathParam"
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"$ref": "#/components/parameters/HydrateEntitiesQueryParam"
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"in": "query",
|
|
180
|
+
"name": "fields",
|
|
181
|
+
"style": "form",
|
|
182
|
+
"explode": false
|
|
183
|
+
}
|
|
184
|
+
]
|
|
185
|
+
}
|
|
186
|
+
},
|
|
165
187
|
"/v1/entity/{slug}/{id}": {
|
|
166
188
|
"get": {
|
|
167
189
|
"operationId": "getEntity",
|
|
@@ -596,7 +618,14 @@
|
|
|
596
618
|
},
|
|
597
619
|
"/v1/entity/views": {
|
|
598
620
|
"get": {
|
|
599
|
-
"operationId": "listSavedViews"
|
|
621
|
+
"operationId": "listSavedViews",
|
|
622
|
+
"parameters": [
|
|
623
|
+
{
|
|
624
|
+
"in": "query",
|
|
625
|
+
"name": "slug",
|
|
626
|
+
"required": false
|
|
627
|
+
}
|
|
628
|
+
]
|
|
600
629
|
}
|
|
601
630
|
},
|
|
602
631
|
"/v1/entity/view": {
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1681,6 +1681,16 @@ declare namespace Components {
|
|
|
1681
1681
|
*/
|
|
1682
1682
|
enable_thumbnails?: boolean;
|
|
1683
1683
|
}
|
|
1684
|
+
/**
|
|
1685
|
+
* List of entity field to return. Negation and globbing is supported.
|
|
1686
|
+
* example:
|
|
1687
|
+
* [
|
|
1688
|
+
* "first_name",
|
|
1689
|
+
* "address.*",
|
|
1690
|
+
* "!**.metadata"
|
|
1691
|
+
* ]
|
|
1692
|
+
*/
|
|
1693
|
+
export type EntityFields = string[];
|
|
1684
1694
|
export type EntityId = string; // uuid
|
|
1685
1695
|
/**
|
|
1686
1696
|
* The parameters for importing entities.
|
|
@@ -2520,16 +2530,22 @@ declare namespace Components {
|
|
|
2520
2530
|
* When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
|
|
2521
2531
|
*/
|
|
2522
2532
|
hydrate?: boolean;
|
|
2523
|
-
/**
|
|
2524
|
-
* List of entity fields to include in
|
|
2533
|
+
fields?: /**
|
|
2534
|
+
* List of entity fields to include or exclude in the response
|
|
2535
|
+
*
|
|
2536
|
+
* Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
|
|
2537
|
+
*
|
|
2525
2538
|
* example:
|
|
2526
2539
|
* [
|
|
2527
2540
|
* "_id",
|
|
2528
2541
|
* "_title",
|
|
2529
|
-
* "first_name"
|
|
2542
|
+
* "first_name",
|
|
2543
|
+
* "account",
|
|
2544
|
+
* "!account.*._files",
|
|
2545
|
+
* "**._product"
|
|
2530
2546
|
* ]
|
|
2531
2547
|
*/
|
|
2532
|
-
|
|
2548
|
+
FieldsParam;
|
|
2533
2549
|
/**
|
|
2534
2550
|
* Adds a `_score` number field to results that can be used to rank by match score
|
|
2535
2551
|
*/
|
|
@@ -2636,6 +2652,22 @@ declare namespace Components {
|
|
|
2636
2652
|
* abc123
|
|
2637
2653
|
*/
|
|
2638
2654
|
export type ExportJobId = string;
|
|
2655
|
+
/**
|
|
2656
|
+
* List of entity fields to include or exclude in the response
|
|
2657
|
+
*
|
|
2658
|
+
* Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
|
|
2659
|
+
*
|
|
2660
|
+
* example:
|
|
2661
|
+
* [
|
|
2662
|
+
* "_id",
|
|
2663
|
+
* "_title",
|
|
2664
|
+
* "first_name",
|
|
2665
|
+
* "account",
|
|
2666
|
+
* "!account.*._files",
|
|
2667
|
+
* "**._product"
|
|
2668
|
+
* ]
|
|
2669
|
+
*/
|
|
2670
|
+
export type FieldsParam = string[];
|
|
2639
2671
|
/**
|
|
2640
2672
|
* File or Image Attachment
|
|
2641
2673
|
*/
|
|
@@ -6463,6 +6495,81 @@ declare namespace Paths {
|
|
|
6463
6495
|
}
|
|
6464
6496
|
}
|
|
6465
6497
|
}
|
|
6498
|
+
namespace GetEntityV2 {
|
|
6499
|
+
namespace Parameters {
|
|
6500
|
+
export type Fields = /**
|
|
6501
|
+
* List of entity field to return. Negation and globbing is supported.
|
|
6502
|
+
* example:
|
|
6503
|
+
* [
|
|
6504
|
+
* "first_name",
|
|
6505
|
+
* "address.*",
|
|
6506
|
+
* "!**.metadata"
|
|
6507
|
+
* ]
|
|
6508
|
+
*/
|
|
6509
|
+
Components.Schemas.EntityFields;
|
|
6510
|
+
export type Hydrate = boolean;
|
|
6511
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
6512
|
+
export type Slug = /**
|
|
6513
|
+
* URL-friendly identifier for the entity schema
|
|
6514
|
+
* example:
|
|
6515
|
+
* contact
|
|
6516
|
+
*/
|
|
6517
|
+
Components.Schemas.EntitySlug;
|
|
6518
|
+
}
|
|
6519
|
+
export interface PathParameters {
|
|
6520
|
+
id: Parameters.Id;
|
|
6521
|
+
slug: Parameters.Slug;
|
|
6522
|
+
}
|
|
6523
|
+
export interface QueryParameters {
|
|
6524
|
+
hydrate?: Parameters.Hydrate;
|
|
6525
|
+
fields?: Parameters.Fields;
|
|
6526
|
+
}
|
|
6527
|
+
namespace Responses {
|
|
6528
|
+
export type $200 = /**
|
|
6529
|
+
* example:
|
|
6530
|
+
* {
|
|
6531
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
6532
|
+
* "_org": "123",
|
|
6533
|
+
* "_owners": [
|
|
6534
|
+
* {
|
|
6535
|
+
* "org_id": "123",
|
|
6536
|
+
* "user_id": "123"
|
|
6537
|
+
* },
|
|
6538
|
+
* {
|
|
6539
|
+
* "org_id": "123",
|
|
6540
|
+
* "user_id": "123"
|
|
6541
|
+
* }
|
|
6542
|
+
* ],
|
|
6543
|
+
* "_schema": "contact",
|
|
6544
|
+
* "_tags": [
|
|
6545
|
+
* "example",
|
|
6546
|
+
* "mock",
|
|
6547
|
+
* "example",
|
|
6548
|
+
* "mock"
|
|
6549
|
+
* ],
|
|
6550
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
6551
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
6552
|
+
* "_acl": {
|
|
6553
|
+
* "view": [
|
|
6554
|
+
* "org:456",
|
|
6555
|
+
* "org:789",
|
|
6556
|
+
* "org:456",
|
|
6557
|
+
* "org:789"
|
|
6558
|
+
* ],
|
|
6559
|
+
* "edit": [
|
|
6560
|
+
* "org:456",
|
|
6561
|
+
* "org:456"
|
|
6562
|
+
* ],
|
|
6563
|
+
* "delete": [
|
|
6564
|
+
* "org:456",
|
|
6565
|
+
* "org:456"
|
|
6566
|
+
* ]
|
|
6567
|
+
* }
|
|
6568
|
+
* }
|
|
6569
|
+
*/
|
|
6570
|
+
Components.Schemas.EntityItem;
|
|
6571
|
+
}
|
|
6572
|
+
}
|
|
6466
6573
|
namespace GetRelatedEntitiesCount {
|
|
6467
6574
|
namespace Parameters {
|
|
6468
6575
|
export type ExcludeSchemas = /**
|
|
@@ -6534,15 +6641,16 @@ declare namespace Paths {
|
|
|
6534
6641
|
}
|
|
6535
6642
|
namespace GetRelationsV2 {
|
|
6536
6643
|
namespace Parameters {
|
|
6537
|
-
/**
|
|
6644
|
+
export type Fields = /**
|
|
6645
|
+
* List of entity field to return. Negation and globbing is supported.
|
|
6538
6646
|
* example:
|
|
6539
6647
|
* [
|
|
6540
|
-
* "
|
|
6541
|
-
* "
|
|
6542
|
-
* "
|
|
6648
|
+
* "first_name",
|
|
6649
|
+
* "address.*",
|
|
6650
|
+
* "!**.metadata"
|
|
6543
6651
|
* ]
|
|
6544
6652
|
*/
|
|
6545
|
-
|
|
6653
|
+
Components.Schemas.EntityFields;
|
|
6546
6654
|
export type From = number;
|
|
6547
6655
|
export type Hydrate = boolean;
|
|
6548
6656
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
@@ -6566,15 +6674,7 @@ declare namespace Paths {
|
|
|
6566
6674
|
include_reverse?: Parameters.IncludeReverse;
|
|
6567
6675
|
from?: Parameters.From;
|
|
6568
6676
|
size?: Parameters.Size;
|
|
6569
|
-
fields?:
|
|
6570
|
-
* example:
|
|
6571
|
-
* [
|
|
6572
|
-
* "_id",
|
|
6573
|
-
* "_schema",
|
|
6574
|
-
* "_title"
|
|
6575
|
-
* ]
|
|
6576
|
-
*/
|
|
6577
|
-
Parameters.Fields;
|
|
6677
|
+
fields?: Parameters.Fields;
|
|
6578
6678
|
}
|
|
6579
6679
|
namespace Responses {
|
|
6580
6680
|
export type $200 = Components.Schemas.GetRelationsRespWithPagination;
|
|
@@ -6723,6 +6823,17 @@ declare namespace Paths {
|
|
|
6723
6823
|
}
|
|
6724
6824
|
}
|
|
6725
6825
|
namespace ListSavedViews {
|
|
6826
|
+
namespace Parameters {
|
|
6827
|
+
export type Slug = /**
|
|
6828
|
+
* URL-friendly identifier for the entity schema
|
|
6829
|
+
* example:
|
|
6830
|
+
* contact
|
|
6831
|
+
*/
|
|
6832
|
+
Components.Schemas.EntitySlug;
|
|
6833
|
+
}
|
|
6834
|
+
export interface QueryParameters {
|
|
6835
|
+
slug?: Parameters.Slug;
|
|
6836
|
+
}
|
|
6726
6837
|
namespace Responses {
|
|
6727
6838
|
export interface $200 {
|
|
6728
6839
|
results?: /* A saved entity view */ Components.Schemas.SavedViewItem[];
|
|
@@ -7482,6 +7593,19 @@ export interface OperationMethods {
|
|
|
7482
7593
|
data?: Paths.UpsertEntity.RequestBody,
|
|
7483
7594
|
config?: AxiosRequestConfig
|
|
7484
7595
|
): OperationResponse<Paths.UpsertEntity.Responses.$200 | Paths.UpsertEntity.Responses.$201>
|
|
7596
|
+
/**
|
|
7597
|
+
* getEntityV2 - getEntityV2
|
|
7598
|
+
*
|
|
7599
|
+
* Gets Entity by id.
|
|
7600
|
+
*
|
|
7601
|
+
* Supports `hydrate` and `fields` parameters to control the shape of the response.
|
|
7602
|
+
*
|
|
7603
|
+
*/
|
|
7604
|
+
'getEntityV2'(
|
|
7605
|
+
parameters?: Parameters<Paths.GetEntityV2.PathParameters & Paths.GetEntityV2.QueryParameters> | null,
|
|
7606
|
+
data?: any,
|
|
7607
|
+
config?: AxiosRequestConfig
|
|
7608
|
+
): OperationResponse<Paths.GetEntityV2.Responses.$200>
|
|
7485
7609
|
/**
|
|
7486
7610
|
* getEntity - getEntity
|
|
7487
7611
|
*
|
|
@@ -7813,7 +7937,7 @@ export interface OperationMethods {
|
|
|
7813
7937
|
* Get the Saved Views based on the schema
|
|
7814
7938
|
*/
|
|
7815
7939
|
'listSavedViews'(
|
|
7816
|
-
parameters?: Parameters<
|
|
7940
|
+
parameters?: Parameters<Paths.ListSavedViews.QueryParameters> | null,
|
|
7817
7941
|
data?: any,
|
|
7818
7942
|
config?: AxiosRequestConfig
|
|
7819
7943
|
): OperationResponse<Paths.ListSavedViews.Responses.$200>
|
|
@@ -8135,6 +8259,21 @@ export interface PathsDictionary {
|
|
|
8135
8259
|
config?: AxiosRequestConfig
|
|
8136
8260
|
): OperationResponse<Paths.UpsertEntity.Responses.$200 | Paths.UpsertEntity.Responses.$201>
|
|
8137
8261
|
}
|
|
8262
|
+
['/v2/entity/{slug}/{id}']: {
|
|
8263
|
+
/**
|
|
8264
|
+
* getEntityV2 - getEntityV2
|
|
8265
|
+
*
|
|
8266
|
+
* Gets Entity by id.
|
|
8267
|
+
*
|
|
8268
|
+
* Supports `hydrate` and `fields` parameters to control the shape of the response.
|
|
8269
|
+
*
|
|
8270
|
+
*/
|
|
8271
|
+
'get'(
|
|
8272
|
+
parameters?: Parameters<Paths.GetEntityV2.PathParameters & Paths.GetEntityV2.QueryParameters> | null,
|
|
8273
|
+
data?: any,
|
|
8274
|
+
config?: AxiosRequestConfig
|
|
8275
|
+
): OperationResponse<Paths.GetEntityV2.Responses.$200>
|
|
8276
|
+
}
|
|
8138
8277
|
['/v1/entity/{slug}/{id}']: {
|
|
8139
8278
|
/**
|
|
8140
8279
|
* getEntity - getEntity
|
|
@@ -8493,7 +8632,7 @@ export interface PathsDictionary {
|
|
|
8493
8632
|
* Get the Saved Views based on the schema
|
|
8494
8633
|
*/
|
|
8495
8634
|
'get'(
|
|
8496
|
-
parameters?: Parameters<
|
|
8635
|
+
parameters?: Parameters<Paths.ListSavedViews.QueryParameters> | null,
|
|
8497
8636
|
data?: any,
|
|
8498
8637
|
config?: AxiosRequestConfig
|
|
8499
8638
|
): OperationResponse<Paths.ListSavedViews.Responses.$200>
|
package/dist/openapi.json
CHANGED
|
@@ -520,6 +520,49 @@
|
|
|
520
520
|
}
|
|
521
521
|
}
|
|
522
522
|
},
|
|
523
|
+
"/v2/entity/{slug}/{id}": {
|
|
524
|
+
"get": {
|
|
525
|
+
"operationId": "getEntityV2",
|
|
526
|
+
"summary": "getEntityV2",
|
|
527
|
+
"description": "Gets Entity by id.\n\nSupports `hydrate` and `fields` parameters to control the shape of the response.\n",
|
|
528
|
+
"tags": [
|
|
529
|
+
"Entities"
|
|
530
|
+
],
|
|
531
|
+
"parameters": [
|
|
532
|
+
{
|
|
533
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
534
|
+
},
|
|
535
|
+
{
|
|
536
|
+
"$ref": "#/components/parameters/EntitySlugPathParam"
|
|
537
|
+
},
|
|
538
|
+
{
|
|
539
|
+
"$ref": "#/components/parameters/HydrateEntitiesQueryParam"
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"in": "query",
|
|
543
|
+
"name": "fields",
|
|
544
|
+
"description": "List of entity fields to include in results",
|
|
545
|
+
"style": "form",
|
|
546
|
+
"explode": false,
|
|
547
|
+
"schema": {
|
|
548
|
+
"$ref": "#/components/schemas/EntityFields"
|
|
549
|
+
}
|
|
550
|
+
}
|
|
551
|
+
],
|
|
552
|
+
"responses": {
|
|
553
|
+
"200": {
|
|
554
|
+
"description": "Success",
|
|
555
|
+
"content": {
|
|
556
|
+
"application/json": {
|
|
557
|
+
"schema": {
|
|
558
|
+
"$ref": "#/components/schemas/EntityItem"
|
|
559
|
+
}
|
|
560
|
+
}
|
|
561
|
+
}
|
|
562
|
+
}
|
|
563
|
+
}
|
|
564
|
+
}
|
|
565
|
+
},
|
|
523
566
|
"/v1/entity/{slug}/{id}": {
|
|
524
567
|
"get": {
|
|
525
568
|
"operationId": "getEntity",
|
|
@@ -1198,15 +1241,7 @@
|
|
|
1198
1241
|
"name": "fields",
|
|
1199
1242
|
"description": "List of entity fields to include in results",
|
|
1200
1243
|
"schema": {
|
|
1201
|
-
"
|
|
1202
|
-
"items": {
|
|
1203
|
-
"type": "string"
|
|
1204
|
-
},
|
|
1205
|
-
"example": [
|
|
1206
|
-
"_id",
|
|
1207
|
-
"_schema",
|
|
1208
|
-
"_title"
|
|
1209
|
-
]
|
|
1244
|
+
"$ref": "#/components/schemas/EntityFields"
|
|
1210
1245
|
}
|
|
1211
1246
|
}
|
|
1212
1247
|
],
|
|
@@ -1531,6 +1566,17 @@
|
|
|
1531
1566
|
"tags": [
|
|
1532
1567
|
"Saved Views"
|
|
1533
1568
|
],
|
|
1569
|
+
"parameters": [
|
|
1570
|
+
{
|
|
1571
|
+
"in": "query",
|
|
1572
|
+
"name": "slug",
|
|
1573
|
+
"description": "Return views belonging to this schema",
|
|
1574
|
+
"required": false,
|
|
1575
|
+
"schema": {
|
|
1576
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
1577
|
+
}
|
|
1578
|
+
}
|
|
1579
|
+
],
|
|
1534
1580
|
"responses": {
|
|
1535
1581
|
"200": {
|
|
1536
1582
|
"description": "Success",
|
|
@@ -3844,6 +3890,18 @@
|
|
|
3844
3890
|
"route": "/app/pricing-hub/product/:entityId"
|
|
3845
3891
|
}
|
|
3846
3892
|
},
|
|
3893
|
+
"EntityFields": {
|
|
3894
|
+
"description": "List of entity field to return. Negation and globbing is supported.",
|
|
3895
|
+
"type": "array",
|
|
3896
|
+
"items": {
|
|
3897
|
+
"type": "string"
|
|
3898
|
+
},
|
|
3899
|
+
"example": [
|
|
3900
|
+
"first_name",
|
|
3901
|
+
"address.*",
|
|
3902
|
+
"!**.metadata"
|
|
3903
|
+
]
|
|
3904
|
+
},
|
|
3847
3905
|
"EntityId": {
|
|
3848
3906
|
"type": "string",
|
|
3849
3907
|
"format": "uuid"
|
|
@@ -4190,16 +4248,7 @@
|
|
|
4190
4248
|
"default": false
|
|
4191
4249
|
},
|
|
4192
4250
|
"fields": {
|
|
4193
|
-
"
|
|
4194
|
-
"description": "List of entity fields to include in search results",
|
|
4195
|
-
"items": {
|
|
4196
|
-
"type": "string"
|
|
4197
|
-
},
|
|
4198
|
-
"example": [
|
|
4199
|
-
"_id",
|
|
4200
|
-
"_title",
|
|
4201
|
-
"first_name"
|
|
4202
|
-
]
|
|
4251
|
+
"$ref": "#/components/schemas/FieldsParam"
|
|
4203
4252
|
},
|
|
4204
4253
|
"include_scores": {
|
|
4205
4254
|
"type": "boolean",
|
|
@@ -4222,6 +4271,21 @@
|
|
|
4222
4271
|
"q"
|
|
4223
4272
|
]
|
|
4224
4273
|
},
|
|
4274
|
+
"FieldsParam": {
|
|
4275
|
+
"type": "array",
|
|
4276
|
+
"description": "List of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n",
|
|
4277
|
+
"items": {
|
|
4278
|
+
"type": "string"
|
|
4279
|
+
},
|
|
4280
|
+
"example": [
|
|
4281
|
+
"_id",
|
|
4282
|
+
"_title",
|
|
4283
|
+
"first_name",
|
|
4284
|
+
"account",
|
|
4285
|
+
"!account.*._files",
|
|
4286
|
+
"**._product"
|
|
4287
|
+
]
|
|
4288
|
+
},
|
|
4225
4289
|
"EntityImportParams": {
|
|
4226
4290
|
"type": "object",
|
|
4227
4291
|
"properties": {
|