@epilot/entity-client 4.2.0 → 4.3.1

package/dist/openapi.d.ts

@@ -2723,7 +2723,9 @@ declare namespace Components {
             protected?: boolean;
             type?: "relation";
             relation_type?: "has_many" | "has_one";
-            delete_mode?: "cascade";
+            /**
+             * Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity.
+             */
             relation_affinity_mode?: "weak" | "strong";
             /**
              * When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.
@@ -2835,6 +2837,10 @@ declare namespace Components {
              * 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:
@@ -2956,6 +2962,9 @@ declare namespace Components {
             protected?: boolean;
             repeatable?: boolean;
             has_primary?: boolean;
+            /**
+             * Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.
+             */
             relation_affinity_mode?: "weak" | "strong";
             type?: "string" | "phone" | "email" | "address" | "relation" | "payment" | "price_component" | "date";
             /**
@@ -2963,6 +2972,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
          */
@@ -3686,6 +3802,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 = /**
@@ -3737,6 +3859,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 */;
@@ -3911,6 +4045,19 @@ declare namespace Paths {
             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 */;
@@ -3963,6 +4110,13 @@ declare namespace Paths {
             }
         }
     }
+    namespace ListSavedViews {
+        namespace Responses {
+            export interface $200 {
+                results?: /* A saved entity view */ Components.Schemas.SavedViewItem[];
+            }
+        }
+    }
     namespace ListSchemaBlueprints {
         namespace Responses {
             export interface $200 {
@@ -4056,6 +4210,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 = /**
@@ -4560,6 +4726,56 @@ export interface OperationMethods {
     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 {
@@ -5030,6 +5246,62 @@ export interface PathsDictionary {
       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>

package/dist/openapi.json

@@ -25,6 +25,10 @@
         {
             "name": "Export",
             "description": "Export and Import entities via files"
+        },
+        {
+            "name": "Saved Views",
+            "description": "Saved Views for Entities"
         }
     ],
     "security": [
@@ -1333,6 +1337,169 @@
                     }
                 }
             }
+        },
+        "/v1/entity/views": {
+            "get": {
+                "operationId": "listSavedViews",
+                "summary": "listSavedViews",
+                "description": "Get the Saved Views based on the schema",
+                "tags": [
+                    "Saved Views"
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Success",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "results": {
+                                            "type": "array",
+                                            "items": {
+                                                "$ref": "#/components/schemas/SavedViewItem"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "/v1/entity/view": {
+            "post": {
+                "operationId": "createSavedView",
+                "summary": "createSavedView",
+                "description": "Creates a new saved view",
+                "tags": [
+                    "Saved Views"
+                ],
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/SavedView"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "201": {
+                        "description": "Success",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/SavedViewItem"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "/v1/entity/view/{id}": {
+            "get": {
+                "operationId": "getSavedView",
+                "summary": "getSavedView",
+                "description": "Gets Saved View configuration by id.",
+                "tags": [
+                    "Saved Views"
+                ],
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "id",
+                        "description": "View id",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/components/schemas/SavedViewId"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Success",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "view": {
+                                            "$ref": "#/components/schemas/SavedViewItem"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            },
+            "put": {
+                "operationId": "updateSavedView",
+                "summary": "updateSavedView",
+                "description": "Updates a saved view",
+                "tags": [
+                    "Saved Views"
+                ],
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "id",
+                        "description": "View id",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/components/schemas/SavedViewId"
+                        }
+                    }
+                ],
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/SavedView"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "Success",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/SavedViewItem"
+                                }
+                            }
+                        }
+                    }
+                }
+            },
+            "delete": {
+                "operationId": "deleteSavedView",
+                "summary": "deleteSavedView",
+                "description": "Deletes a saved view",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "id",
+                        "description": "View id",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/components/schemas/SavedViewId"
+                        }
+                    }
+                ],
+                "tags": [
+                    "Saved Views"
+                ],
+                "responses": {
+                    "200": {
+                        "description": "List of all available saved views"
+                    }
+                }
+            }
         }
     },
     "components": {
@@ -1388,7 +1555,7 @@
                         "type": "array",
                         "items": {
                             "type": "string",
-                            "example": "ecommerce_preview"
+                            "example": "360_features"
                         }
                     },
                     "name": {
@@ -2290,13 +2457,8 @@
                                     "has_one"
                                 ]
                             },
-                            "delete_mode": {
-                                "type": "string",
-                                "enum": [
-                                    "cascade"
-                                ]
-                            },
                             "relation_affinity_mode": {
+                                "description": "Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity.",
                                 "type": "string",
                                 "enum": [
                                     "weak",
@@ -2419,6 +2581,10 @@
                             "add_button_label": {
                                 "type": "string",
                                 "description": "Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is."
+                            },
+                            "search_placeholder": {
+                                "type": "string",
+                                "description": "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."
                             }
                         }
                     }
@@ -2564,6 +2730,7 @@
                                 "type": "boolean"
                             },
                             "relation_affinity_mode": {
+                                "description": "Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.",
                                 "type": "string",
                                 "enum": [
                                     "weak",
@@ -3666,6 +3833,101 @@
                 "description": "Reference to blueprint",
                 "type": "string",
                 "format": "uuid"
+            },
+            "SavedViewId": {
+                "description": "Generated uuid for a saved view",
+                "type": "string",
+                "format": "uuid"
+            },
+            "SavedViewItem": {
+                "allOf": [
+                    {
+                        "type": "object",
+                        "properties": {
+                            "id": {
+                                "$ref": "#/components/schemas/SavedViewId"
+                            },
+                            "created_at": {
+                                "type": "string"
+                            },
+                            "updated_at": {
+                                "type": "string"
+                            }
+                        }
+                    },
+                    {
+                        "$ref": "#/components/schemas/SavedView"
+                    }
+                ]
+            },
+            "SavedView": {
+                "description": "A saved entity view",
+                "type": "object",
+                "properties": {
+                    "slug": {
+                        "type": "array",
+                        "description": "list of schemas a view can belong to",
+                        "items": {
+                            "$ref": "#/components/schemas/EntitySlug"
+                        }
+                    },
+                    "name": {
+                        "description": "User-friendly identifier for the saved view",
+                        "type": "string",
+                        "example": "View listing German customers"
+                    },
+                    "created_by": {
+                        "anyOf": [
+                            {
+                                "type": "object",
+                                "description": "A user that created the view",
+                                "properties": {
+                                    "user_id": {
+                                        "type": "string",
+                                        "example": "10598"
+                                    }
+                                }
+                            },
+                            {
+                                "type": "object",
+                                "description": "A system-created view",
+                                "properties": {
+                                    "source": {
+                                        "type": "string",
+                                        "enum": [
+                                            "SYSTEM",
+                                            "BLUEPRINT"
+                                        ]
+                                    }
+                                },
+                                "additionalProperties": true
+                            }
+                        ]
+                    },
+                    "ui_config": {
+                        "type": "object",
+                        "example": {
+                            "filters": {
+                                "customer_name": "suresh test",
+                                "_tags": "360"
+                            },
+                            "table_layout": {
+                                "opportunity": {
+                                    "page": 1,
+                                    "sort": "_created_at:desc",
+                                    "pageSize": 25,
+                                    "columnSettings": []
+                                }
+                            }
+                        }
+                    }
+                },
+                "required": [
+                    "slug",
+                    "name",
+                    "created_by",
+                    "ui_config"
+                ]
             }
         },
         "examples": {