@epilot/entity-client 4.31.1 → 4.32.0

package/dist/openapi.json

@@ -744,6 +744,9 @@
           },
           {
             "$ref": "#/components/parameters/AsyncOperationQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/ValidateEntityQueryParam"
           }
         ],
         "requestBody": {
@@ -800,6 +803,16 @@
                 }
               }
             }
+          },
+          "422": {
+            "description": "Entity validation error when `?validate=true`",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntityValidationV2ResultError"
+                }
+              }
+            }
           }
         }
       }
@@ -858,6 +871,60 @@
         }
       }
     },
+    "/v2/entity/{slug}:validate": {
+      "post": {
+        "operationId": "validateEntityV2",
+        "summary": "validateEntityV2",
+        "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/EntityValidationV2ResultSuccess"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntityValidationV2ResultError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/entity/{slug}:upsert": {
       "patch": {
         "operationId": "upsertEntity",
@@ -882,6 +949,9 @@
           {
             "$ref": "#/components/parameters/AsyncOperationQueryParam"
           },
+          {
+            "$ref": "#/components/parameters/ValidateEntityQueryParam"
+          },
           {
             "name": "strict",
             "description": "Strict mode = return 409 if more than one entity is matched",
@@ -948,6 +1018,16 @@
           },
           "409": {
             "description": "Conflict: multiple entities were matched with `unique_key`"
+          },
+          "422": {
+            "description": "Entity validation error when `?validate=true`",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntityValidationV2ResultError"
+                }
+              }
+            }
           }
         }
       }
@@ -1109,6 +1189,9 @@
           },
           {
             "$ref": "#/components/parameters/AsyncOperationQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/ValidateEntityQueryParam"
           }
         ],
         "requestBody": {
@@ -1131,6 +1214,16 @@
                 }
               }
             }
+          },
+          "422": {
+            "description": "Entity validation error when `?validate=true`",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntityValidationV2ResultError"
+                }
+              }
+            }
           }
         }
       },
@@ -1159,6 +1252,9 @@
           },
           {
             "$ref": "#/components/parameters/AsyncOperationQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/ValidateEntityQueryParam"
           }
         ],
         "requestBody": {
@@ -1185,6 +1281,16 @@
           },
           "409": {
             "description": "Conflict: newer version exists"
+          },
+          "422": {
+            "description": "Entity validation error when `?validate=true`",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntityValidationV2ResultError"
+                }
+              }
+            }
           }
         }
       },
@@ -2031,7 +2137,7 @@
       "post": {
         "operationId": "exportEntities",
         "summary": "exportEntities",
-        "description": "create export file of entities",
+        "description": "Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.\nThe values exported as in some cases, transformed to human-readable values.\n\nTo force the export of raw values, use the `#` prefix in front of your field name when specifying the field on the `fields` param.\n",
         "tags": [
           "Export"
         ],
@@ -3431,6 +3537,15 @@
             "type": "string",
             "example": "Contacts"
           },
+          "description": {
+            "type": "string",
+            "example": "Example description"
+          },
+          "docs_url": {
+            "type": "string",
+            "format": "uri",
+            "example": "https://docs.epilot.io/docs/pricing/entities"
+          },
           "published": {
             "type": "boolean",
             "example": false
@@ -3834,6 +3949,16 @@
               "$ref": "#/components/schemas/ClassificationId"
             }
           },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest ID used to create/update the schema group",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            },
+            "nullable": true
+          },
           "feature_flag": {
             "type": "string",
             "example": "FF_MY_FEATURE_FLAG",
@@ -4073,6 +4198,16 @@
               "$ref": "#/components/schemas/ClassificationId"
             }
           },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest ID used to create/update the schema attribute",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            },
+            "nullable": true
+          },
           "constraints": {
             "type": "object",
             "description": "A set of constraints applicable to the attribute.\nThese constraints should and will be enforced by the attribute renderer.\n",
@@ -5199,10 +5334,25 @@
               "top_divider",
               "bottom_divider"
             ]
+          },
+          "_purpose": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ClassificationId"
+            }
+          },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest ID used to create/update the schema group headline",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            },
+            "nullable": true
           }
         },
         "required": [
-          "id",
           "name",
           "label",
           "group",
@@ -5268,6 +5418,16 @@
               "$ref": "#/components/schemas/ClassificationId"
             }
           },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest ID used to create/update the schema capabilility",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            },
+            "nullable": true
+          },
           "ui_hooks": {
             "type": "array",
             "items": {
@@ -5890,6 +6050,112 @@
           }
         ]
       },
+      "EntityValidationV2Error": {
+        "type": "object",
+        "properties": {
+          "keyword": {
+            "type": "string",
+            "description": "validation keyword."
+          },
+          "instance_path": {
+            "type": "string",
+            "description": "JSON Pointer to the location in the data instance (e.g., `\"/prop/1/subProp\"`)."
+          },
+          "schema_path": {
+            "type": "string",
+            "description": "JSON Pointer to the location of the failing keyword in the schema."
+          },
+          "params": {
+            "type": "object",
+            "description": "Additional information about error.",
+            "additionalProperties": true
+          },
+          "property_name": {
+            "type": "string",
+            "description": "Set for errors in `propertyNames` keyword schema. `instance_path` still points to the object in this case."
+          },
+          "message": {
+            "type": "string",
+            "description": "The error message."
+          },
+          "schema": {
+            "type": "object",
+            "description": "The value of the failing keyword in the schema."
+          },
+          "parent_schema": {
+            "type": "object",
+            "description": "The schema containing the keyword.",
+            "additionalProperties": true
+          },
+          "data": {
+            "type": "object",
+            "description": "The data validated by the keyword.",
+            "additionalProperties": true
+          }
+        },
+        "required": [
+          "keyword",
+          "instance_path",
+          "schema_path",
+          "params"
+        ]
+      },
+      "EntityValidationV2ResultSuccess": {
+        "type": "object",
+        "description": "Validation result for a successful validation",
+        "properties": {
+          "status": {
+            "type": "string",
+            "enum": [
+              "success"
+            ]
+          },
+          "errors": {
+            "type": "array",
+            "maxItems": 0,
+            "items": {
+              "$ref": "#/components/schemas/EntityValidationV2Error"
+            }
+          }
+        },
+        "required": [
+          "status",
+          "errors"
+        ]
+      },
+      "EntityValidationV2ResultError": {
+        "type": "object",
+        "description": "Validation result for a failed validation",
+        "properties": {
+          "status": {
+            "type": "string",
+            "enum": [
+              "error"
+            ]
+          },
+          "errors": {
+            "type": "array",
+            "minItems": 1,
+            "items": {
+              "$ref": "#/components/schemas/EntityValidationV2Error"
+            }
+          }
+        },
+        "required": [
+          "status",
+          "errors"
+        ]
+      },
+      "EntityValidationV2Result": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/EntityValidationV2ResultSuccess"
+          },
+          {
+            "$ref": "#/components/schemas/EntityValidationV2ResultError"
+          }
+        ]
+      },
       "HydratedEntityItem": {
         "allOf": [
           {
@@ -6880,6 +7146,16 @@
           "updated_at": {
             "type": "string",
             "format": "date-time"
+          },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest ID used to create/update the taxonomy classification",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            },
+            "nullable": true
           }
         },
         "required": [
@@ -7176,6 +7452,15 @@
           "type": "boolean",
           "default": false
         }
+      },
+      "ValidateEntityQueryParam": {
+        "name": "validate",
+        "description": "When true, enables entity validation against the entity schema.",
+        "in": "query",
+        "schema": {
+          "default": false,
+          "type": "boolean"
+        }
       }
     },
     "examples": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/entity-client",
-  "version": "4.31.1",
+  "version": "4.32.0",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",