@epilot/entity-client 4.1.7 → 4.3.0

package/dist/openapi.d.ts

@@ -1054,6 +1054,25 @@ declare namespace Components {
             classic_view?: string; // uri
         }
         export type EntityId = string; // uuid
+        export interface EntityImportParams {
+            S3Reference: {
+                /**
+                 * example:
+                 * epilot-files-prod
+                 */
+                bucket: string;
+                /**
+                 * example:
+                 * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
+                 */
+                key: string;
+            };
+            /**
+             * example:
+             * contact
+             */
+            schema: string;
+        }
         /**
          * example:
          * {
@@ -1582,6 +1601,9 @@ declare namespace Components {
              */
             sort?: string;
             from?: number;
+            /**
+             * Max search size is 1000 with higher values defaulting to 1000
+             */
             size?: number;
             /**
              * When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
@@ -1597,6 +1619,10 @@ declare namespace Components {
              * ]
              */
             fields?: string[];
+            /**
+             * Adds a `_score` number field to results that can be used to rank by match score
+             */
+            include_scores?: boolean;
         }
         export interface EntitySearchResults {
             /**
@@ -2128,6 +2154,10 @@ declare namespace Components {
             protected?: boolean;
             type?: "invitation_email";
         }
+        /**
+         * Pass 'true' to generate import template
+         */
+        export type IsTemplate = boolean;
         /**
          * Link with title and href
          */
@@ -2801,6 +2831,14 @@ declare namespace Components {
              * When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item.
              */
             enable_relation_tags?: boolean;
+            /**
+             * Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is.
+             */
+            add_button_label?: string;
+            /**
+             * Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is.
+             */
+            search_placeholder?: string;
         }
         /**
          * example:
@@ -2841,6 +2879,10 @@ declare namespace Components {
             entity_id: EntityId /* uuid */;
             attribute: string;
             _tags?: string[];
+            /**
+             * Whether this is a reverse relation
+             */
+            reverse?: boolean;
         }
         /**
          * Repeatable (add N number of fields)
@@ -2925,6 +2967,113 @@ declare namespace Components {
              */
             enable_relation_picker?: boolean;
         }
+        /**
+         * A saved entity view
+         */
+        export interface SavedView {
+            /**
+             * list of schemas a view can belong to
+             */
+            slug: /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            EntitySlug[];
+            /**
+             * User-friendly identifier for the saved view
+             * example:
+             * View listing German customers
+             */
+            name: string;
+            created_by: {
+                /**
+                 * example:
+                 * 10598
+                 */
+                user_id?: string;
+            } | {
+                [name: string]: any;
+                source?: "SYSTEM" | "BLUEPRINT";
+            };
+            /**
+             * example:
+             * {
+             *   "filters": {
+             *     "customer_name": "suresh test",
+             *     "_tags": "360"
+             *   },
+             *   "table_layout": {
+             *     "opportunity": {
+             *       "page": 1,
+             *       "sort": "_created_at:desc",
+             *       "pageSize": 25,
+             *       "columnSettings": []
+             *     }
+             *   }
+             * }
+             */
+            ui_config: {
+                [key: string]: any;
+            };
+        }
+        /**
+         * Generated uuid for a saved view
+         */
+        export type SavedViewId = string; // uuid
+        /**
+         * A saved entity view
+         */
+        export interface SavedViewItem {
+            id?: /* Generated uuid for a saved view */ SavedViewId /* uuid */;
+            created_at?: string;
+            updated_at?: string;
+            /**
+             * list of schemas a view can belong to
+             */
+            slug: /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            EntitySlug[];
+            /**
+             * User-friendly identifier for the saved view
+             * example:
+             * View listing German customers
+             */
+            name: string;
+            created_by: {
+                /**
+                 * example:
+                 * 10598
+                 */
+                user_id?: string;
+            } | {
+                [name: string]: any;
+                source?: "SYSTEM" | "BLUEPRINT";
+            };
+            /**
+             * example:
+             * {
+             *   "filters": {
+             *     "customer_name": "suresh test",
+             *     "_tags": "360"
+             *   },
+             *   "table_layout": {
+             *     "opportunity": {
+             *       "page": 1,
+             *       "sort": "_created_at:desc",
+             *       "pageSize": 25,
+             *       "columnSettings": []
+             *     }
+             *   }
+             * }
+             */
+            ui_config: {
+                [key: string]: any;
+            };
+        }
         /**
          * Generated uuid for schema
          */
@@ -3648,6 +3797,12 @@ declare namespace Paths {
             export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
         }
     }
+    namespace CreateSavedView {
+        export type RequestBody = /* A saved entity view */ Components.Schemas.SavedView;
+        namespace Responses {
+            export type $201 = /* A saved entity view */ Components.Schemas.SavedViewItem;
+        }
+    }
     namespace DeleteEntity {
         namespace Parameters {
             export type ActivityId = /**
@@ -3699,6 +3854,18 @@ declare namespace Paths {
             }
         }
     }
+    namespace DeleteSavedView {
+        namespace Parameters {
+            export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        namespace Responses {
+            export interface $200 {
+            }
+        }
+    }
     namespace DeleteSchemaById {
         namespace Parameters {
             export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
@@ -3722,10 +3889,12 @@ declare namespace Paths {
     }
     namespace ExportEntities {
         namespace Parameters {
+            export type IsTemplate = /* Pass 'true' to generate import template */ Components.Schemas.IsTemplate;
             export type JobId = /* Export Job Id to get the result */ Components.Schemas.ExportJobId;
         }
         export interface QueryParameters {
             job_id?: Parameters.JobId;
+            is_template?: Parameters.IsTemplate;
         }
         export type RequestBody = Components.Schemas.EntitySearchParams;
         namespace Responses {
@@ -3851,6 +4020,7 @@ declare namespace Paths {
         namespace Parameters {
             export type Hydrate = boolean;
             export type Id = Components.Schemas.EntityId /* uuid */;
+            export type IncludeReverse = boolean;
             export type Slug = /**
              * URL-friendly identifier for the entity schema
              * example:
@@ -3864,11 +4034,25 @@ declare namespace Paths {
         }
         export interface QueryParameters {
             hydrate?: Parameters.Hydrate;
+            include_reverse?: Parameters.IncludeReverse;
         }
         namespace Responses {
             export type $200 = Components.Schemas.GetRelationsResp;
         }
     }
+    namespace GetSavedView {
+        namespace Parameters {
+            export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        namespace Responses {
+            export interface $200 {
+                view?: /* A saved entity view */ Components.Schemas.SavedViewItem;
+            }
+        }
+    }
     namespace GetSchema {
         namespace Parameters {
             export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
@@ -3908,6 +4092,26 @@ declare namespace Paths {
             }
         }
     }
+    namespace ImportEntities {
+        namespace Parameters {
+            export type JobId = /* Export Job Id to get the result */ Components.Schemas.ExportJobId;
+        }
+        export interface QueryParameters {
+            job_id?: Parameters.JobId;
+        }
+        export type RequestBody = Components.Schemas.EntityImportParams;
+        namespace Responses {
+            export interface $201 {
+            }
+        }
+    }
+    namespace ListSavedViews {
+        namespace Responses {
+            export interface $200 {
+                results?: /* A saved entity view */ Components.Schemas.SavedViewItem[];
+            }
+        }
+    }
     namespace ListSchemaBlueprints {
         namespace Responses {
             export interface $200 {
@@ -4001,6 +4205,18 @@ declare namespace Paths {
             export type $200 = Components.Schemas.RelationItem;
         }
     }
+    namespace UpdateSavedView {
+        namespace Parameters {
+            export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        export type RequestBody = /* A saved entity view */ Components.Schemas.SavedView;
+        namespace Responses {
+            export type $200 = /* A saved entity view */ Components.Schemas.SavedViewItem;
+        }
+    }
     namespace UpsertEntity {
         namespace Parameters {
             export type ActivityId = /**
@@ -4443,7 +4659,12 @@ export interface OperationMethods {
   /**
    * 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.
+   * Returns 1st level direct relations for an entity.
+   * 
+   * 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.
+   * 
    */
   'getRelations'(
     parameters?: Parameters<Paths.GetRelations.PathParameters & Paths.GetRelations.QueryParameters> | null,
@@ -4453,7 +4674,7 @@ export interface OperationMethods {
   /**
    * addRelations - addRelations
    * 
-   * It relates one or more entities to some parent entity, by providing meaning for relations via attribute field.
+   * Relates one or more entities to parent entity by adding items to a relation attribute
    */
   'addRelations'(
     parameters?: Parameters<Paths.AddRelations.PathParameters> | null,
@@ -4463,7 +4684,7 @@ export interface OperationMethods {
   /**
    * updateRelation - updateRelation
    * 
-   * It updates a relation between two entities.
+   * Updates an existing relation between two entities.
    */
   'updateRelation'(
     parameters?: Parameters<Paths.UpdateRelation.PathParameters> | null,
@@ -4473,7 +4694,7 @@ export interface OperationMethods {
   /**
    * deleteRelation - deleteRelation
    * 
-   * It deletes a relation between one entity and the other.
+   * Removes relation between two entities
    */
   'deleteRelation'(
     parameters?: Parameters<Paths.DeleteRelation.PathParameters> | null,
@@ -4490,6 +4711,66 @@ export interface OperationMethods {
     data?: Paths.ExportEntities.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ExportEntities.Responses.$201>
+  /**
+   * importEntities - importEntities
+   * 
+   * import entity data from
+   */
+  'importEntities'(
+    parameters?: Parameters<Paths.ImportEntities.QueryParameters> | null,
+    data?: Paths.ImportEntities.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ImportEntities.Responses.$201>
+  /**
+   * listSavedViews - listSavedViews
+   * 
+   * Get the Saved Views based on the schema
+   */
+  'listSavedViews'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListSavedViews.Responses.$200>
+  /**
+   * createSavedView - createSavedView
+   * 
+   * Creates a new saved view
+   */
+  'createSavedView'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreateSavedView.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateSavedView.Responses.$201>
+  /**
+   * getSavedView - getSavedView
+   * 
+   * Gets Saved View configuration by id.
+   */
+  'getSavedView'(
+    parameters?: Parameters<Paths.GetSavedView.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetSavedView.Responses.$200>
+  /**
+   * updateSavedView - updateSavedView
+   * 
+   * Updates a saved view
+   */
+  'updateSavedView'(
+    parameters?: Parameters<Paths.UpdateSavedView.PathParameters> | null,
+    data?: Paths.UpdateSavedView.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpdateSavedView.Responses.$200>
+  /**
+   * deleteSavedView - deleteSavedView
+   * 
+   * Deletes a saved view
+   */
+  'deleteSavedView'(
+    parameters?: Parameters<Paths.DeleteSavedView.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -4891,7 +5172,12 @@ export interface PathsDictionary {
     /**
      * 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.
+     * Returns 1st level direct relations for an entity.
+     * 
+     * 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.GetRelations.PathParameters & Paths.GetRelations.QueryParameters> | null,
@@ -4901,7 +5187,7 @@ export interface PathsDictionary {
     /**
      * addRelations - addRelations
      * 
-     * It relates one or more entities to some parent entity, by providing meaning for relations via attribute field.
+     * Relates one or more entities to parent entity by adding items to a relation attribute
      */
     'post'(
       parameters?: Parameters<Paths.AddRelations.PathParameters> | null,
@@ -4913,7 +5199,7 @@ export interface PathsDictionary {
     /**
      * updateRelation - updateRelation
      * 
-     * It updates a relation between two entities.
+     * Updates an existing relation between two entities.
      */
     'put'(
       parameters?: Parameters<Paths.UpdateRelation.PathParameters> | null,
@@ -4923,7 +5209,7 @@ export interface PathsDictionary {
     /**
      * deleteRelation - deleteRelation
      * 
-     * It deletes a relation between one entity and the other.
+     * Removes relation between two entities
      */
     'delete'(
       parameters?: Parameters<Paths.DeleteRelation.PathParameters> | null,
@@ -4943,6 +5229,74 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ExportEntities.Responses.$201>
   }
+  ['/v1/entity:import']: {
+    /**
+     * importEntities - importEntities
+     * 
+     * import entity data from
+     */
+    'post'(
+      parameters?: Parameters<Paths.ImportEntities.QueryParameters> | null,
+      data?: Paths.ImportEntities.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ImportEntities.Responses.$201>
+  }
+  ['/v1/entity/views']: {
+    /**
+     * listSavedViews - listSavedViews
+     * 
+     * Get the Saved Views based on the schema
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListSavedViews.Responses.$200>
+  }
+  ['/v1/entity/view']: {
+    /**
+     * createSavedView - createSavedView
+     * 
+     * Creates a new saved view
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CreateSavedView.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateSavedView.Responses.$201>
+  }
+  ['/v1/entity/view/{id}']: {
+    /**
+     * getSavedView - getSavedView
+     * 
+     * Gets Saved View configuration by id.
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetSavedView.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetSavedView.Responses.$200>
+    /**
+     * updateSavedView - updateSavedView
+     * 
+     * Updates a saved view
+     */
+    'put'(
+      parameters?: Parameters<Paths.UpdateSavedView.PathParameters> | null,
+      data?: Paths.UpdateSavedView.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpdateSavedView.Responses.$200>
+    /**
+     * deleteSavedView - deleteSavedView
+     * 
+     * Deletes a saved view
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteSavedView.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>