@epilot/entity-client 4.21.0-rc.3 → 4.22.0

package/dist/openapi.json

@@ -32,7 +32,7 @@
     },
     {
       "name": "Taxonomy",
-      "description": "Entity classification with Taxonomies"
+      "description": "Taxonomies and Classifications"
     },
     {
       "name": "Elastic Cluster Assignment",
@@ -1651,6 +1651,46 @@
             "schema": {
               "$ref": "#/components/schemas/EntitySlug"
             }
+          },
+          {
+            "in": "query",
+            "name": "sort",
+            "description": "The sort key to use if present",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "default": "name:asc"
+            }
+          },
+          {
+            "in": "query",
+            "name": "from",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 0
+            }
+          },
+          {
+            "in": "query",
+            "name": "size",
+            "description": "Number of saved views to return",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "default": 80,
+              "minimum": 1,
+              "maximum": 250
+            }
+          },
+          {
+            "in": "query",
+            "name": "fields",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/FieldsParam"
+            }
           }
         ],
         "responses": {
@@ -1659,15 +1699,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {
-                    "results": {
-                      "type": "array",
-                      "items": {
-                        "$ref": "#/components/schemas/SavedViewItem"
-                      }
-                    }
-                  }
+                  "$ref": "#/components/schemas/ListSavedViewsResults"
                 }
               }
             }
@@ -1725,12 +1757,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {
-                    "view": {
-                      "$ref": "#/components/schemas/SavedViewItem"
-                    }
-                  }
+                  "$ref": "#/components/schemas/SavedViewItem"
                 }
               }
             }
@@ -1822,12 +1849,24 @@
     },
     "/v1/entity/listTaxonomies": {
       "get": {
+        "deprecated": true,
         "operationId": "listTaxonomies",
         "summary": "listTaxonomies",
         "description": "List taxonomies in an organisation",
         "tags": [
           "Taxonomy"
         ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "include_disabled",
+            "description": "Include disabled taxonomies",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          }
+        ],
         "responses": {
           "200": {
             "description": "Returns list of taxonomies in an organisation",
@@ -1850,6 +1889,115 @@
         }
       }
     },
+    "/v1/entity/taxonomies": {
+      "get": {
+        "operationId": "listTaxonomies",
+        "summary": "listTaxonomies",
+        "description": "List taxonomies in an organization",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "include_disabled",
+            "description": "Include disabled taxonomies",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          }
+        ],
+        "tags": [
+          "Taxonomy"
+        ],
+        "responses": {
+          "200": {
+            "description": "Returns list of taxonomies in an organization",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/Taxonomy"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "operationId": "createTaxonomy",
+        "summary": "createTaxonomy",
+        "description": "Create a new taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "slug": {
+                    "$ref": "#/components/schemas/TaxonomySlug"
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag",
+                    "example": "Purpose"
+                  },
+                  "plural": {
+                    "type": "string",
+                    "description": "Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.",
+                    "example": "Purposes"
+                  },
+                  "icon": {
+                    "type": "string",
+                    "description": "Icon name for the taxonomy (from epilot360/icons icon set)",
+                    "example": "purpose"
+                  },
+                  "color": {
+                    "type": "string",
+                    "description": "HEX Color code for the taxonomy",
+                    "example": "#FF5733"
+                  }
+                },
+                "required": [
+                  "slug",
+                  "name"
+                ],
+                "example": {
+                  "slug": "product-category",
+                  "name": "Product Category",
+                  "plural": "Product Categories",
+                  "icon": "product-hub",
+                  "color": "#FF5733"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Taxonomy created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Taxonomy"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Taxonomy already exists"
+          }
+        }
+      }
+    },
     "/v1/entity/taxonomies/{taxonomySlug}": {
       "get": {
         "operationId": "getTaxonomy",
@@ -1875,6 +2023,100 @@
             }
           }
         }
+      },
+      "put": {
+        "operationId": "updateTaxonomy",
+        "summary": "updateTaxonomy",
+        "description": "Update a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag",
+                    "example": "Purpose"
+                  },
+                  "plural": {
+                    "type": "string",
+                    "description": "Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.",
+                    "example": "Purposes"
+                  },
+                  "icon": {
+                    "type": "string",
+                    "description": "Icon name for the taxonomy (from epilot360/icons icon set)",
+                    "example": "purpose"
+                  },
+                  "color": {
+                    "type": "string",
+                    "description": "HEX Color code for the taxonomy",
+                    "example": "#FF5733"
+                  },
+                  "enabled": {
+                    "type": "boolean",
+                    "description": "Whether the taxonomy is enabled or not",
+                    "example": true
+                  }
+                },
+                "example": {
+                  "name": "Product Category",
+                  "plural": "Product Categories",
+                  "icon": "product-hub",
+                  "color": "#FF5733",
+                  "enabled": true
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Taxonomy updated",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Taxonomy"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteTaxonomy",
+        "summary": "deleteTaxonomy",
+        "description": "Delete a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          },
+          {
+            "in": "query",
+            "name": "permanent",
+            "description": "If true, the taxonomy will be permanently deleted",
+            "schema": {
+              "type": "boolean"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Taxonomy deleted"
+          }
+        }
       }
     },
     "/v1/entity/taxonomies/{taxonomySlug}:autocomplete": {
@@ -1932,13 +2174,22 @@
       "post": {
         "operationId": "taxonomiesClassificationsSearch",
         "summary": "taxonomiesClassificationsSearch",
-        "description": "List taxonomy classifications in an organisation based on taxonomy slug",
+        "description": "List taxonomy classifications in an organization based on taxonomy slug",
         "tags": [
           "Taxonomy"
         ],
         "parameters": [
           {
-            "$ref": "#/components/parameters/TaxonomySlugQueryParam"
+            "$ref": "#/components/parameters/TaxonomySlugQueryParamOptional"
+          },
+          {
+            "in": "query",
+            "name": "query",
+            "description": "Input to search",
+            "schema": {
+              "type": "string",
+              "example": "sales"
+            }
           }
         ],
         "requestBody": {
@@ -1960,7 +2211,7 @@
         },
         "responses": {
           "200": {
-            "description": "Returns list of taxonomy classifications",
+            "description": "Returns the classifications for the taxonomy slug provided",
             "content": {
               "application/json": {
                 "schema": {
@@ -1984,7 +2235,7 @@
       "post": {
         "operationId": "updateClassificationsForTaxonomy",
         "summary": "updateClassificationsForTaxonomy",
-        "description": "Update taxonomies in an organisation based in taxonomy slug",
+        "description": "Update the classifications for a taxonomy",
         "tags": [
           "Taxonomy"
         ],
@@ -2035,6 +2286,116 @@
           }
         }
       }
+    },
+    "/v2/entity/taxonomies/{taxonomySlug}/classifications": {
+      "post": {
+        "operationId": "createTaxonomyClassification",
+        "summary": "createTaxonomyClassification",
+        "description": "Create a new classification for a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TaxonomyClassification"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Taxonomy classification created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TaxonomyClassification"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Taxonomy classification already exists\""
+          }
+        }
+      }
+    },
+    "/v2/entity/taxonomies/{taxonomySlug}/classifications/{classificationSlug}": {
+      "put": {
+        "operationId": "updateTaxonomyClassification",
+        "summary": "updateTaxonomyClassification",
+        "description": "Update a classification for a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          },
+          {
+            "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TaxonomyClassification"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Taxonomy classification updated",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TaxonomyClassification"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Taxonomy classification not found"
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteTaxonomyClassification",
+        "summary": "deleteTaxonomyClassification",
+        "description": "Delete a classification for a taxonomy",
+        "tags": [
+          "Taxonomy"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/TaxonomySlugPathParam"
+          },
+          {
+            "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
+          },
+          {
+            "in": "query",
+            "name": "permanent",
+            "description": "If true, the classification will be permanently deleted",
+            "schema": {
+              "type": "boolean"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Taxonomy classification deleted"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -4710,6 +5071,21 @@
         "type": "string",
         "format": "uuid"
       },
+      "ListSavedViewsResults": {
+        "type": "object",
+        "properties": {
+          "hits": {
+            "type": "number",
+            "example": 1
+          },
+          "results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SavedViewItem"
+            }
+          }
+        }
+      },
       "SavedViewId": {
         "description": "Generated uuid for a saved view",
         "type": "string",
@@ -4839,22 +5215,57 @@
           },
           "plural": {
             "type": "string",
-            "description": "Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags",
+            "description": "Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.",
             "example": "Purposes"
           },
+          "kind": {
+            "readonly": true,
+            "type": "string",
+            "enum": [
+              "system",
+              "user_defined"
+            ],
+            "description": "Kind of taxonomy e.g. system or user_defined. By default, it's empty, which means 'user_defined'",
+            "example": "system"
+          },
+          "icon": {
+            "type": "string",
+            "description": "Icon name for the taxonomy (from epilot360/icons icon set)",
+            "example": "purpose"
+          },
+          "color": {
+            "type": "string",
+            "description": "HEX Color code for the taxonomy",
+            "example": "#FF5733"
+          },
           "created_at": {
+            "readonly": true,
             "type": "string",
             "format": "date-time"
           },
           "updated_at": {
+            "readonly": true,
             "type": "string",
             "format": "date-time"
+          },
+          "deleted_at": {
+            "readonly": true,
+            "type": "string",
+            "format": "date-time",
+            "description": "Date when the taxonomy was soft-deleted (enabled: false)"
+          },
+          "created_by": {
+            "readonly": true,
+            "type": "string",
+            "description": "User ID of the creator",
+            "example": "10598"
+          },
+          "enabled": {
+            "type": "boolean",
+            "description": "Whether the taxonomy is enabled or not",
+            "example": true
           }
-        },
-        "required": [
-          "slug",
-          "name"
-        ]
+        }
       },
       "TaxonomyClassification": {
         "type": "object",
@@ -4862,6 +5273,11 @@
           "id": {
             "$ref": "#/components/schemas/ClassificationId"
           },
+          "slug": {
+            "type": "string",
+            "description": "URL-friendly identifier for the classification",
+            "example": "wallbox-pv"
+          },
           "name": {
             "type": "string",
             "example": "Wallbox PV"
@@ -4887,7 +5303,7 @@
       },
       "ClassificationId": {
         "type": "string",
-        "format": "uuid"
+        "example": "taxonomy-slug:classification-slug"
       },
       "TaxonomySlug": {
         "type": "string",
@@ -4912,7 +5328,15 @@
           "delete": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/ClassificationId"
+              "anyOf": [
+                {
+                  "$ref": "#/components/schemas/ClassificationId"
+                },
+                {
+                  "type": "string",
+                  "example": "taxonomy-slug:classification-slug"
+                }
+              ]
             }
           }
         }
@@ -4964,18 +5388,26 @@
           "example": "price"
         }
       },
-      "TaxonomySlugQueryParam": {
+      "TaxonomySlugPathParam": {
         "name": "taxonomySlug",
         "description": "Taxonomy slug",
-        "in": "query",
+        "in": "path",
+        "required": true,
         "schema": {
           "type": "string"
-        },
-        "required": true
+        }
       },
-      "TaxonomySlugPathParam": {
+      "TaxonomySlugQueryParamOptional": {
         "name": "taxonomySlug",
         "description": "Taxonomy slug",
+        "in": "query",
+        "schema": {
+          "type": "string"
+        }
+      },
+      "TaxonomyClassificationSlugPathParam": {
+        "name": "classificationSlug",
+        "description": "Taxonomy Classification slug",
         "in": "path",
         "required": true,
         "schema": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/entity-client",
-  "version": "4.21.0-rc.3",
+  "version": "4.22.0",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,8 +29,7 @@
     "build": "tsc && npm run bundle-definition",
     "build:watch": "npm run build && tsc -w",
     "release-alpha": "npm version prerelease --preid alpha",
-    "lint": "../../node_modules/eslint/bin/eslint.js src",
-    "prepublishOnly": "npm run typegen && npm run build"
+    "lint": "../../node_modules/eslint/bin/eslint.js src"
   },
   "files": [
     "*.js",