@epilot/entity-client 4.8.0 → 4.8.1

package/dist/openapi.d.ts

@@ -1382,21 +1382,6 @@ declare namespace Components {
                 Entity;
             };
         }
-        /**
-         * example:
-         * {
-         *   "type": "redirect",
-         *   "route": "/app/pricing-hub/product/:entityId"
-         * }
-         */
-        export interface EntityParcelView {
-            view_type?: "parcel";
-            /**
-             * example:
-             * @epilot360/pricing-hub-app
-             */
-            import?: string;
-        }
         /**
          * The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.
          */
@@ -1452,10 +1437,38 @@ declare namespace Components {
              */
             title_template?: string;
             ui_config?: {
-                table_view?: EntityViewConfig;
-                create_view?: EntityViewConfig;
-                edit_view?: EntityViewConfig;
-                single_view?: EntityViewConfig;
+                table_view?: EntityDefaultTable | /**
+                 * example:
+                 * {
+                 *   "type": "redirect",
+                 *   "route": "/app/pricing-hub/product/:entityId"
+                 * }
+                 */
+                RedirectEntityView | EntityViewDisabled;
+                create_view?: EntityDefaultCreate | /**
+                 * example:
+                 * {
+                 *   "type": "redirect",
+                 *   "route": "/app/pricing-hub/product/:entityId"
+                 * }
+                 */
+                RedirectEntityView | EntityViewDisabled;
+                edit_view?: EntityDefaultEdit | /**
+                 * example:
+                 * {
+                 *   "type": "redirect",
+                 *   "route": "/app/pricing-hub/product/:entityId"
+                 * }
+                 */
+                RedirectEntityView | EntityViewDisabled;
+                single_view?: EntityDefaultEdit | /**
+                 * example:
+                 * {
+                 *   "type": "redirect",
+                 *   "route": "/app/pricing-hub/product/:entityId"
+                 * }
+                 */
+                RedirectEntityView | EntityViewDisabled;
                 list_item?: {
                     summary_attributes?: (/**
                      * Represents an expanded version of an attribute to be displayed in the list item summary.
@@ -1674,10 +1687,38 @@ declare namespace Components {
              */
             title_template?: string;
             ui_config?: {
-                table_view?: EntityViewConfig;
-                create_view?: EntityViewConfig;
-                edit_view?: EntityViewConfig;
-                single_view?: EntityViewConfig;
+                table_view?: EntityDefaultTable | /**
+                 * example:
+                 * {
+                 *   "type": "redirect",
+                 *   "route": "/app/pricing-hub/product/:entityId"
+                 * }
+                 */
+                RedirectEntityView | EntityViewDisabled;
+                create_view?: EntityDefaultCreate | /**
+                 * example:
+                 * {
+                 *   "type": "redirect",
+                 *   "route": "/app/pricing-hub/product/:entityId"
+                 * }
+                 */
+                RedirectEntityView | EntityViewDisabled;
+                edit_view?: EntityDefaultEdit | /**
+                 * example:
+                 * {
+                 *   "type": "redirect",
+                 *   "route": "/app/pricing-hub/product/:entityId"
+                 * }
+                 */
+                RedirectEntityView | EntityViewDisabled;
+                single_view?: EntityDefaultEdit | /**
+                 * example:
+                 * {
+                 *   "type": "redirect",
+                 *   "route": "/app/pricing-hub/product/:entityId"
+                 * }
+                 */
+                RedirectEntityView | EntityViewDisabled;
                 list_item?: {
                     summary_attributes?: (/**
                      * Represents an expanded version of an attribute to be displayed in the list item summary.
@@ -1869,7 +1910,15 @@ declare namespace Components {
              */
             include_scores?: boolean;
             /**
-             * Aggregation
+             * Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.
+             * example:
+             * {
+             *   "contact-count-per-tag": {
+             *     "terms": {
+             *       "field": "_tags.keyword"
+             *     }
+             *   }
+             * }
              */
             aggs?: {
                 [key: string]: any;
@@ -1898,6 +1947,25 @@ declare namespace Components {
              * }
              */
             EntityItem[];
+            /**
+             * example:
+             * {
+             *   "contact-count-per-tag": {
+             *     "doc_count_error_upper_bound": 0,
+             *     "sum_other_doc_count": 23,
+             *     "buckets": [
+             *       {
+             *         "key": "automation",
+             *         "doc_count": 108
+             *       },
+             *       {
+             *         "key": "primary",
+             *         "doc_count": 66
+             *       }
+             *     ]
+             *   }
+             * }
+             */
             aggregations?: {
                 [key: string]: any;
             };
@@ -1908,21 +1976,6 @@ declare namespace Components {
          * contact
          */
         export type EntitySlug = string;
-        export type EntityViewConfig = EntityDefaultCreate | EntityDefaultEdit | EntityDefaultTable | /**
-         * example:
-         * {
-         *   "type": "redirect",
-         *   "route": "/app/pricing-hub/product/:entityId"
-         * }
-         */
-        RedirectEntityView | /**
-         * example:
-         * {
-         *   "type": "redirect",
-         *   "route": "/app/pricing-hub/product/:entityId"
-         * }
-         */
-        EntityParcelView | EntityViewDisabled;
         export interface EntityViewDisabled {
             view_type?: "disabled";
         }
@@ -2049,6 +2102,14 @@ declare namespace Components {
          * }
          */
         RelationEntity)[];
+        export interface GetRelationsRespWithPagination {
+            /**
+             * example:
+             * 1
+             */
+            hits?: number;
+            relations?: GetRelationsResp;
+        }
         /**
          * Entity with relation data resolved into the attribute values
          * example:
@@ -3545,7 +3606,7 @@ declare namespace Components {
              * }
              */
             ui_config: {
-                [key: string]: any;
+                [name: string]: any;
             };
         }
         /**
@@ -3614,7 +3675,7 @@ declare namespace Components {
              * }
              */
             ui_config: {
-                [key: string]: any;
+                [name: string]: any;
             };
         }
         /**
@@ -3728,10 +3789,10 @@ declare namespace Components {
              */
             protected?: boolean;
             type?: "select" | "radio";
-            options?: ((string | null) | {
+            options?: ({
                 value: string;
                 title?: string;
-            })[];
+            } | (string | null))[];
             /**
              * Allow arbitrary input values in addition to provided options
              */
@@ -4707,6 +4768,54 @@ declare namespace Paths {
             export type $200 = Components.Schemas.GetRelationsResp;
         }
     }
+    namespace GetRelationsV2 {
+        namespace Parameters {
+            /**
+             * example:
+             * [
+             *   "_id",
+             *   "_schema",
+             *   "_title"
+             * ]
+             */
+            export type Fields = string[];
+            export type From = number;
+            export type Hydrate = boolean;
+            export type Id = Components.Schemas.EntityId /* uuid */;
+            export type IncludeReverse = boolean;
+            export type Query = string;
+            export type Size = number;
+            export type Slug = /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            Components.Schemas.EntitySlug;
+        }
+        export interface PathParameters {
+            slug: Parameters.Slug;
+            id: Parameters.Id;
+        }
+        export interface QueryParameters {
+            hydrate?: Parameters.Hydrate;
+            query?: Parameters.Query;
+            include_reverse?: Parameters.IncludeReverse;
+            from?: Parameters.From;
+            size?: Parameters.Size;
+            fields?: /**
+             * example:
+             * [
+             *   "_id",
+             *   "_schema",
+             *   "_title"
+             * ]
+             */
+            Parameters.Fields;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.GetRelationsRespWithPagination;
+        }
+    }
     namespace GetSavedView {
         namespace Parameters {
             export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
@@ -5528,6 +5637,21 @@ export interface OperationMethods {
     data?: Paths.AddRelations.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.AddRelations.Responses.$200>
+  /**
+   * getRelationsV2 - getRelationsV2
+   * 
+   * Returns 1st level direct relations for an entity with pagination.
+   * 
+   * You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
+   * 
+   * Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
+   * 
+   */
+  'getRelationsV2'(
+    parameters?: Parameters<Paths.GetRelationsV2.PathParameters & Paths.GetRelationsV2.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetRelationsV2.Responses.$200>
   /**
    * updateRelation - updateRelation
    * 
@@ -6104,6 +6228,23 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.AddRelations.Responses.$200>
   }
+  ['/v2/entity/{slug}/{id}/relations']: {
+    /**
+     * getRelationsV2 - getRelationsV2
+     * 
+     * Returns 1st level direct relations for an entity with pagination.
+     * 
+     * You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
+     * 
+     * Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetRelationsV2.PathParameters & Paths.GetRelationsV2.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetRelationsV2.Responses.$200>
+  }
   ['/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}']: {
     /**
      * updateRelation - updateRelation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/entity-client",
-  "version": "4.8.0",
+  "version": "4.8.1",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
     "typescript": "tsc",
     "bundle-definition": "webpack",
     "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/entity.yaml",
-    "typegen": "echo /* eslint-disable */ > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
+    "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
     "build": "tsc && npm run bundle-definition",
     "build:watch": "npm run build && tsc -w",
     "release-alpha": "npm version prerelease --preid alpha",