@epilot/entity-client 4.15.2 → 4.15.4

package/dist/definition.js

@@ -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}]}},"/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})})();
+(()=>{"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/openapi-runtime.json

@@ -437,6 +437,29 @@
           {
             "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
           }
         ]
       },
@@ -525,6 +548,13 @@
             "in": "path",
             "name": "id",
             "required": true
+          },
+          {
+            "in": "query",
+            "name": "exclude_schemas",
+            "required": false,
+            "style": "form",
+            "explode": false
           }
         ]
       }

package/dist/openapi.d.ts

@@ -6382,6 +6382,7 @@ declare namespace Paths {
     }
     namespace GetRelatedEntitiesCount {
         namespace Parameters {
+            export type ExcludeSchemas = string[];
             export type Id = Components.Schemas.EntityId /* uuid */;
             export type Slug = /**
              * URL-friendly identifier for the entity schema
@@ -6394,15 +6395,32 @@ declare namespace Paths {
             slug: Parameters.Slug;
             id: Parameters.Id;
         }
+        export interface QueryParameters {
+            exclude_schemas?: Parameters.ExcludeSchemas;
+        }
         namespace Responses {
             export type $200 = Components.Schemas.GetRelatedEntitiesCount;
         }
     }
     namespace GetRelations {
         namespace Parameters {
+            export type ExcludeSchemas = /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            Components.Schemas.EntitySlug[];
+            export type From = number;
             export type Hydrate = boolean;
             export type Id = Components.Schemas.EntityId /* uuid */;
             export type IncludeReverse = boolean;
+            export type IncludeSchemas = /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            Components.Schemas.EntitySlug[];
+            export type Size = number;
             export type Slug = /**
              * URL-friendly identifier for the entity schema
              * example:
@@ -6417,9 +6435,13 @@ declare namespace Paths {
         export interface QueryParameters {
             hydrate?: Parameters.Hydrate;
             include_reverse?: Parameters.IncludeReverse;
+            from?: Parameters.From;
+            size?: Parameters.Size;
+            include_schemas?: Parameters.IncludeSchemas;
+            exclude_schemas?: Parameters.ExcludeSchemas;
         }
         namespace Responses {
-            export type $200 = Components.Schemas.GetRelationsResp;
+            export type $200 = Components.Schemas.GetRelationsRespWithPagination;
         }
     }
     namespace GetRelationsV2 {
@@ -7601,7 +7623,7 @@ export interface OperationMethods {
    * 
    */
   'getRelatedEntitiesCount'(
-    parameters?: Parameters<Paths.GetRelatedEntitiesCount.PathParameters> | null,
+    parameters?: Parameters<Paths.GetRelatedEntitiesCount.PathParameters & Paths.GetRelatedEntitiesCount.QueryParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetRelatedEntitiesCount.Responses.$200>
@@ -8256,7 +8278,7 @@ export interface PathsDictionary {
      * 
      */
     'get'(
-      parameters?: Parameters<Paths.GetRelatedEntitiesCount.PathParameters> | null,
+      parameters?: Parameters<Paths.GetRelatedEntitiesCount.PathParameters & Paths.GetRelatedEntitiesCount.QueryParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetRelatedEntitiesCount.Responses.$200>

package/dist/openapi.json

@@ -1237,6 +1237,56 @@
               "default": false,
               "type": "boolean"
             }
+          },
+          {
+            "in": "query",
+            "name": "from",
+            "description": "Starting page number",
+            "schema": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 0
+            }
+          },
+          {
+            "in": "query",
+            "name": "size",
+            "description": "Number of results to return per page",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 1000,
+              "default": 100
+            }
+          },
+          {
+            "in": "query",
+            "name": "include_schemas",
+            "description": "Filter results to only include schemas",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/EntitySlug"
+              }
+            }
+          },
+          {
+            "in": "query",
+            "name": "exclude_schemas",
+            "description": "Filter results to exclude schemas",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/EntitySlug"
+              }
+            }
           }
         ],
         "responses": {
@@ -1245,7 +1295,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/GetRelationsResp"
+                  "$ref": "#/components/schemas/GetRelationsRespWithPagination"
                 },
                 "example": [
                   {
@@ -1492,7 +1542,7 @@
           {
             "in": "path",
             "name": "slug",
-            "description": "Entity Type",
+            "description": "Entity Schema",
             "required": true,
             "schema": {
               "$ref": "#/components/schemas/EntitySlug"
@@ -1506,6 +1556,21 @@
             "schema": {
               "$ref": "#/components/schemas/EntityId"
             }
+          },
+          {
+            "in": "query",
+            "name": "exclude_schemas",
+            "description": "To be excluded from the count by given schemas",
+            "required": false,
+            "style": "form",
+            "example": "<url>/count?exclude_schemas=file,message",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
           }
         ],
         "responses": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/entity-client",
-  "version": "4.15.2",
+  "version": "4.15.4",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",