@epilot/entity-client 2.4.3 → 2.6.1

package/dist/openapi.d.ts

@@ -864,9 +864,10 @@ declare namespace Components {
             entity: EntityId /* uuid */;
             /**
              * example:
-             * updateEntity
+             * 123
              */
-            operation?: string;
+            org: string;
+            operation: "createEntity" | "updateEntity" | "deleteEntity";
             /**
              * example:
              * {
@@ -992,6 +993,9 @@ declare namespace Components {
                     grid_template_columns?: string;
                 };
             };
+            dialog_config?: {
+                [name: string]: any;
+            };
             /**
              * An ordered list of attributes the entity contains
              * example:
@@ -1040,6 +1044,18 @@ declare namespace Components {
              * ]
              */
             attributes: Attribute[];
+            explicit_search_mappings?: /**
+             * Advanced: explicit Elasticsearch index mapping definitions for entity data
+             *
+             * example:
+             * {
+             *   "image": {
+             *     "type": "keyword",
+             *     "index": false
+             *   }
+             * }
+             */
+            SearchMappings;
         }
         /**
          * The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.
@@ -1124,6 +1140,9 @@ declare namespace Components {
                     grid_template_columns?: string;
                 };
             };
+            dialog_config?: {
+                [name: string]: any;
+            };
             /**
              * An ordered list of attributes the entity contains
              * example:
@@ -1172,6 +1191,18 @@ declare namespace Components {
              * ]
              */
             attributes: Attribute[];
+            explicit_search_mappings?: /**
+             * Advanced: explicit Elasticsearch index mapping definitions for entity data
+             *
+             * example:
+             * {
+             *   "image": {
+             *     "type": "keyword",
+             *     "index": false
+             *   }
+             * }
+             */
+            SearchMappings;
         }
         export interface EntitySearchParams {
             /**
@@ -1201,10 +1232,6 @@ declare namespace Components {
              * ]
              */
             fields?: string[];
-            /**
-             * Deprecated. Use hydrate=true instead
-             */
-            expand?: string[];
         }
         export interface EntitySearchResults {
             /**
@@ -1320,6 +1347,21 @@ declare namespace Components {
             allowed_types?: string[];
             default_access_control?: "public-read" | "private";
         }
+        export type GetRelationsResp = (RelationItem | /**
+         * example:
+         * {
+         *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+         *   "_org": "123",
+         *   "_schema": "contact",
+         *   "_tags": [
+         *     "example",
+         *     "mock"
+         *   ],
+         *   "_created_at": {},
+         *   "_updated_at": {}
+         * }
+         */
+        RelationEntity)[];
         /**
          * Entity with relation data resolved into the attribute values
          * example:
@@ -1812,6 +1854,46 @@ declare namespace Components {
              */
             enable_relation_tags?: boolean;
         }
+        /**
+         * example:
+         * {
+         *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+         *   "_org": "123",
+         *   "_schema": "contact",
+         *   "_tags": [
+         *     "example",
+         *     "mock"
+         *   ],
+         *   "_created_at": {},
+         *   "_updated_at": {}
+         * }
+         */
+        export interface RelationEntity {
+            _id: EntityId /* uuid */;
+            /**
+             * Title of entity
+             */
+            _title: string;
+            /**
+             * Organization Id the entity belongs to
+             */
+            _org: string;
+            _schema: /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            EntitySlug;
+            _tags?: string[];
+            _created_at: string; // date-time
+            _updated_at: string; // date-time
+            $relation?: RelationItem;
+        }
+        export interface RelationItem {
+            entity_id: EntityId /* uuid */;
+            attribute: string;
+            _tags?: string[];
+        }
         /**
          * Repeatable (add N number of fields)
          */
@@ -1885,6 +1967,26 @@ declare namespace Components {
          * Generated uuid for schema
          */
         export type SchemaId = string; // uuid
+        /**
+         * Advanced: explicit Elasticsearch index mapping definitions for entity data
+         *
+         * example:
+         * {
+         *   "image": {
+         *     "type": "keyword",
+         *     "index": false
+         *   }
+         * }
+         */
+        export interface SearchMappings {
+            [name: string]: {
+                index?: boolean;
+                type?: "keyword" | "text" | "boolean" | "integer" | "long" | "float" | "date" | "flattened" | "nested";
+                fields?: {
+                    [name: string]: any;
+                };
+            };
+        }
         /**
          * Dropdown select
          */
@@ -2157,6 +2259,25 @@ declare namespace Components {
     }
 }
 declare namespace Paths {
+    namespace AddRelations {
+        namespace Parameters {
+            export type Id = Components.Schemas.EntityId /* uuid */;
+            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 type RequestBody = Components.Schemas.RelationItem[];
+        namespace Responses {
+            export type $200 = Components.Schemas.RelationItem;
+        }
+    }
     namespace AttachActivity {
         namespace Parameters {
             export type Entities = Components.Schemas.EntityId /* uuid */[];
@@ -2302,6 +2423,29 @@ declare namespace Paths {
             }
         }
     }
+    namespace DeleteRelation {
+        namespace Parameters {
+            export type Attribute = string;
+            export type EntityId = string;
+            export type Id = Components.Schemas.EntityId /* uuid */;
+            export type Slug = /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            Components.Schemas.EntitySlug;
+        }
+        export interface PathParameters {
+            slug: Parameters.Slug;
+            id: Parameters.Id;
+            attribute: Parameters.Attribute;
+            entity_id: Parameters.EntityId;
+        }
+        namespace Responses {
+            export interface $204 {
+            }
+        }
+    }
     namespace DeleteSchema {
         namespace Parameters {
             export type Slug = /**
@@ -2433,6 +2577,28 @@ declare namespace Paths {
             }
         }
     }
+    namespace GetRelations {
+        namespace Parameters {
+            export type Hydrate = boolean;
+            export type Id = Components.Schemas.EntityId /* uuid */;
+            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;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.GetRelationsResp;
+        }
+    }
     namespace GetSchema {
         namespace Parameters {
             export type Slug = /**
@@ -2521,6 +2687,31 @@ declare namespace Paths {
             Components.Schemas.EntityItem;
         }
     }
+    namespace UpdateRelation {
+        namespace Parameters {
+            export type Attribute = string;
+            export type EntityId = string;
+            export type Id = Components.Schemas.EntityId /* uuid */;
+            export type Slug = /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            Components.Schemas.EntitySlug;
+        }
+        export interface PathParameters {
+            slug: Parameters.Slug;
+            id: Parameters.Id;
+            attribute: Parameters.Attribute;
+            entity_id: Parameters.EntityId;
+        }
+        export interface RequestBody {
+            _tags?: string[];
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.RelationItem;
+        }
+    }
     namespace UpsertEntity {
         namespace Parameters {
             export type ActivityId = /**
@@ -2888,6 +3079,46 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetEntityActivityFeed.Responses.$200>
+  /**
+   * getRelations - getRelations
+   * 
+   * It loads 1st level relations for the mentioned entity. You can control whether entire related entity is loaded or not via hydrate param.
+   */
+  'getRelations'(
+    parameters?: Parameters<Paths.GetRelations.PathParameters & Paths.GetRelations.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetRelations.Responses.$200>
+  /**
+   * addRelations - addRelations
+   * 
+   * It relates one or more entities to some parent entity, by providing meaning for relations via attribute field.
+   */
+  'addRelations'(
+    parameters?: Parameters<Paths.AddRelations.PathParameters> | null,
+    data?: Paths.AddRelations.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.AddRelations.Responses.$200>
+  /**
+   * updateRelation - updateRelation
+   * 
+   * It updates a relation between two entities.
+   */
+  'updateRelation'(
+    parameters?: Parameters<Paths.UpdateRelation.PathParameters> | null,
+    data?: Paths.UpdateRelation.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpdateRelation.Responses.$200>
+  /**
+   * deleteRelation - deleteRelation
+   * 
+   * It deletes a relation between one entity and the other.
+   */
+  'deleteRelation'(
+    parameters?: Parameters<Paths.DeleteRelation.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteRelation.Responses.$204>
 }
 
 export interface PathsDictionary {
@@ -3211,6 +3442,50 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetEntityActivityFeed.Responses.$200>
   }
+  ['/v1/entity/{slug}/{id}/relations']: {
+    /**
+     * getRelations - getRelations
+     * 
+     * It loads 1st level relations for the mentioned entity. You can control whether entire related entity is loaded or not via hydrate param.
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetRelations.PathParameters & Paths.GetRelations.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetRelations.Responses.$200>
+    /**
+     * addRelations - addRelations
+     * 
+     * It relates one or more entities to some parent entity, by providing meaning for relations via attribute field.
+     */
+    'post'(
+      parameters?: Parameters<Paths.AddRelations.PathParameters> | null,
+      data?: Paths.AddRelations.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.AddRelations.Responses.$200>
+  }
+  ['/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}']: {
+    /**
+     * updateRelation - updateRelation
+     * 
+     * It updates a relation between two entities.
+     */
+    'put'(
+      parameters?: Parameters<Paths.UpdateRelation.PathParameters> | null,
+      data?: Paths.UpdateRelation.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpdateRelation.Responses.$200>
+    /**
+     * deleteRelation - deleteRelation
+     * 
+     * It deletes a relation between one entity and the other.
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteRelation.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteRelation.Responses.$204>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>