@epilot/entity-client 4.20.2 → 4.20.4

package/dist/openapi.json

@@ -222,6 +222,24 @@
             "schema": {
               "type": "number"
             }
+          },
+          {
+            "in": "query",
+            "name": "fields",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "example": [
+                "id",
+                "attributes",
+                "capabilites"
+              ]
+            }
           }
         ],
         "responses": {
@@ -447,6 +465,60 @@
         }
       }
     },
+    "/v1/entity/{slug}:validate": {
+      "post": {
+        "operationId": "validateEntity",
+        "summary": "validateEntity",
+        "description": "Validates an entity against the schema.",
+        "tags": [
+          "Entities"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntitySlugPathPriceParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Entity"
+              },
+              "examples": {
+                "Valid Price": {
+                  "$ref": "#/components/examples/PriceEntity"
+                },
+                "Invalid Price": {
+                  "$ref": "#/components/examples/EmptyGenericEntity"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntityValidationResultSuccess"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntityValidationResultError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/entity/{slug}:upsert": {
       "patch": {
         "operationId": "upsertEntity",
@@ -1963,39 +2035,6 @@
           }
         }
       }
-    },
-    "/v1/clusterAssignment/{orgId}": {
-      "get": {
-        "operationId": "getElasticClusterForOrg",
-        "summary": "getElasticClusterForOrg",
-        "description": "Gets the Elastic cluster assignment by orgId.",
-        "tags": [
-          "Elastic Cluster Assignment"
-        ],
-        "parameters": [
-          {
-            "in": "path",
-            "name": "orgId",
-            "description": "The organization to fetch the cluster assigment",
-            "required": true,
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Success",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ESClusterAssignment"
-                }
-              }
-            }
-          }
-        }
-      }
     }
   },
   "components": {
@@ -2213,10 +2252,12 @@
                   "example": "FF_MY_FEATURE_FLAG",
                   "description": "This group should only be active when the feature flag is enabled"
                 },
-                "setting_flag": {
-                  "type": "string",
-                  "example": "MY_SETTING",
-                  "description": "This group should only be active when the setting is enabled"
+                "settings_flag": {
+                  "type": "array",
+                  "description": "This group should only be active when all the settings have the correct value",
+                  "items": {
+                    "$ref": "#/components/schemas/SettingFlag"
+                  }
                 },
                 "info_tooltip_title": {
                   "type": "object",
@@ -2546,10 +2587,12 @@
             "example": "FF_MY_FEATURE_FLAG",
             "description": "This attribute should only be active when the feature flag is enabled"
           },
-          "setting_flag": {
-            "type": "string",
-            "example": "MY_SETTING",
-            "description": "This attribute should only be active when the setting is enabled"
+          "settings_flag": {
+            "type": "array",
+            "description": "This attribute should only be active when all the settings have the correct value",
+            "items": {
+              "$ref": "#/components/schemas/SettingFlag"
+            }
           },
           "value_formatter": {
             "type": "string"
@@ -3135,9 +3178,12 @@
                       "type": "string",
                       "description": "Name of the feature flag that enables this action"
                     },
-                    "setting_flag": {
-                      "type": "string",
-                      "description": "Name of the setting flag that enables this action"
+                    "settings_flag": {
+                      "type": "array",
+                      "description": "This action should only be active when all the settings have the correct value",
+                      "items": {
+                        "$ref": "#/components/schemas/SettingFlag"
+                      }
                     },
                     "new_entity_item": {
                       "type": "object",
@@ -3598,9 +3644,12 @@
             "type": "string",
             "description": "Binds summary field visibility to the feature flag state."
           },
-          "setting_flag": {
-            "type": "string",
-            "description": "Binds summary field visibility to the setting flag state."
+          "settings_flag": {
+            "type": "array",
+            "description": "This summary attribute should only be visible when all the settings have the correct value",
+            "items": {
+              "$ref": "#/components/schemas/SettingFlag"
+            }
           }
         },
         "required": [
@@ -3723,10 +3772,12 @@
             "example": "FF_MY_FEATURE_FLAG",
             "description": "This capability should only be active when the feature flag is enabled"
           },
-          "setting_flag": {
-            "type": "string",
-            "example": "MY_SETTING",
-            "description": "This capability should only be active when the setting is enabled"
+          "settings_flag": {
+            "type": "array",
+            "description": "This capability should only be active when all the settings have the correct value",
+            "items": {
+              "$ref": "#/components/schemas/SettingFlag"
+            }
           }
         },
         "required": [
@@ -4061,6 +4112,105 @@
         },
         "additionalProperties": true
       },
+      "EntityItem": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseEntity"
+          },
+          {
+            "$ref": "#/components/schemas/Entity"
+          }
+        ]
+      },
+      "EntityValidationError": {
+        "type": "object",
+        "description": "Validation error for an entity attribute",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Error code identifier",
+            "example": "custom"
+          },
+          "params": {
+            "type": "object",
+            "description": "Additional parameters for the error",
+            "properties": {
+              "type": {
+                "type": "string",
+                "description": "The type of the error",
+                "example": "missing_field"
+              }
+            }
+          },
+          "path": {
+            "type": "array",
+            "description": "The path to the attribute that failed validation",
+            "items": {
+              "type": "string"
+            },
+            "example": [
+              "first_name"
+            ]
+          },
+          "message": {
+            "type": "string",
+            "description": "A human-readable message describing the error",
+            "example": "Invalid input"
+          }
+        },
+        "required": [
+          "code",
+          "params",
+          "path",
+          "message"
+        ]
+      },
+      "EntityValidationResultSuccess": {
+        "type": "object",
+        "description": "Validation result for a successful validation",
+        "properties": {
+          "status": {
+            "type": "string",
+            "enum": [
+              "success"
+            ]
+          },
+          "errors": {
+            "type": "array",
+            "maxItems": 0,
+            "items": {
+              "$ref": "#/components/schemas/EntityValidationError"
+            }
+          }
+        },
+        "required": [
+          "status",
+          "errors"
+        ]
+      },
+      "EntityValidationResultError": {
+        "type": "object",
+        "description": "Validation result for a failed validation",
+        "properties": {
+          "status": {
+            "type": "string",
+            "enum": [
+              "error"
+            ]
+          },
+          "errors": {
+            "type": "array",
+            "minItems": 1,
+            "items": {
+              "$ref": "#/components/schemas/EntityValidationError"
+            }
+          }
+        },
+        "required": [
+          "status",
+          "errors"
+        ]
+      },
       "HydratedEntity": {
         "type": "object",
         "description": "Entity with relation data resolved into the attribute values",
@@ -4152,6 +4302,16 @@
           }
         ]
       },
+      "HydratedEntityItem": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseEntity"
+          },
+          {
+            "$ref": "#/components/schemas/HydratedEntity"
+          }
+        ]
+      },
       "GetRelationsResp": {
         "type": "array",
         "items": {
@@ -4818,16 +4978,16 @@
           }
         }
       },
-      "ESClusterAssignment": {
+      "SettingFlag": {
         "type": "object",
         "properties": {
-          "orgId": {
+          "name": {
             "type": "string",
-            "description": "The organization for which the cluster assignment is returned"
+            "description": "The name of the organization setting to check"
           },
-          "cluster": {
-            "type": "string",
-            "description": "Name of the elastic cluster the organization is assigned to"
+          "enabled": {
+            "type": "boolean",
+            "description": "Whether the setting should be enabled or not"
           }
         }
       }
@@ -4851,6 +5011,20 @@
           "$ref": "#/components/schemas/EntitySlug"
         }
       },
+      "EntitySlugPathPriceParam": {
+        "name": "slug",
+        "description": "Entity Type",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "allOf": [
+            {
+              "$ref": "#/components/schemas/EntitySlug"
+            }
+          ],
+          "example": "price"
+        }
+      },
       "TaxonomySlugQueryParam": {
         "name": "taxonomySlug",
         "description": "Taxonomy slug",
@@ -4927,7 +5101,7 @@
       },
       "IncludeReverseDeprecatedQueryParam": {
         "name": "include_reverse",
-        "description": "When true, includes reverse relations in response (other entities pointing to this entity)  \n*It gets overriden by mode query parameter.*\n",
+        "description": "When true, includes reverse relations in response (other entities pointing to this entity)\n*It gets overriden by mode query parameter.*\n",
         "in": "query",
         "deprecated": true,
         "schema": {
@@ -4976,7 +5150,7 @@
       },
       "EntityRelationsModeQueryParam": {
         "name": "mode",
-        "description": "Options to determine how relations will be included in the result.  \n*It overrides the include_reverse query param.*  \nExplanation of possible options:    \n- direct: include relations to which the searched entity refers  \n- reverse: include relations that refer to the entity you are looking for  \n- both: both direct and reverse relations\n",
+        "description": "Options to determine how relations will be included in the result.\n*It overrides the include_reverse query param.*\nExplanation of possible options:\n- direct: include relations to which the searched entity refers\n- reverse: include relations that refer to the entity you are looking for\n- both: both direct and reverse relations\n",
         "in": "query",
         "required": false,
         "schema": {
@@ -5000,6 +5174,10 @@
       }
     },
     "examples": {
+      "EmptyGenericEntity": {
+        "description": "Example of an empty, generic entity",
+        "value": {}
+      },
       "TaxEntity": {
         "description": "Example of a Tax Rate entity",
         "value": {
@@ -5222,6 +5400,7 @@
           "code": "MODEL_375KW_PREMIUM",
           "type": "One Time",
           "description": "Solar Panel 375 kWp Premium",
+          "internal_description": "Solar Panel 375 kWp Premium",
           "billing_scheme": "per_unit",
           "unit_amount": "€ 28500",
           "tiers_mode": "Standard"
@@ -5612,6 +5791,37 @@
             ]
           }
         }
+      },
+      "EntityValidationError": {
+        "description": "Example of an entity validation error",
+        "value": {
+          "code": "string",
+          "params": {
+            "type": "string"
+          },
+          "path": [
+            "string"
+          ],
+          "message": "string"
+        }
+      },
+      "EntityValidationResultSuccess": {
+        "description": "Example of a successful entity validation result",
+        "value": {
+          "status": "success",
+          "errors": []
+        }
+      },
+      "EntityValidationResultError": {
+        "description": "Example of a failed entity validation result",
+        "value": {
+          "status": "error",
+          "errors": [
+            {
+              "$ref": "#/components/examples/EntityValidationError"
+            }
+          ]
+        }
       }
     }
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/entity-client",
-  "version": "4.20.2",
+  "version": "4.20.4",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -72,4 +72,4 @@
     "webpack-cli": "^4.4.0"
   },
   "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
-}
+}