@epilot/entity-client 4.36.0 → 4.38.0-alpha.0

package/dist/openapi.json

@@ -2901,11 +2901,19 @@
           {
             "in": "query",
             "name": "archived",
-            "description": "Filter by archived status",
+            "description": "Filter by archived status. Deprecated. Use `include_archived` instead.",
+            "deprecated": true,
             "schema": {
               "type": "boolean",
               "example": false
             }
+          },
+          {
+            "in": "query",
+            "name": "include_archived",
+            "schema": {
+              "$ref": "#/components/schemas/TaxonomySearchIncludeArchivedParam"
+            }
           }
         ],
         "requestBody": {
@@ -3134,6 +3142,62 @@
         }
       }
     },
+    "/v1/entity/taxonomies/classifications:merge": {
+      "post": {
+        "operationId": "bulkMergeClassifications",
+        "summary": "bulkMergeClassifications",
+        "description": "Merges classifications from one taxonomy into one individual classification, through a bulk async operation which\nalso updates all references from the old Classifications to the new one.\n",
+        "tags": [
+          "Taxonomy"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "job_id": {
+                    "description": "Job ID for tracking the status of a bulk operation request",
+                    "type": "string"
+                  },
+                  "target_classification": {
+                    "description": "The target classification id to which the classifications will be merged into",
+                    "$ref": "#/components/schemas/TaxonomySlug"
+                  },
+                  "classification_ids": {
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/components/schemas/ClassificationId"
+                    }
+                  }
+                }
+              },
+              "example": {
+                "classification_ids": [
+                  "taxonomy-slug:classification-slug"
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Returns the job id for the async job and current status",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TaxonomyBulkJobTriggerResponse"
+                },
+                "example": {
+                  "job_id": "123",
+                  "status": "PENDING"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/entity/taxonomies/classifications:delete": {
       "post": {
         "operationId": "bulkDeleteClassifications",
@@ -4372,9 +4436,6 @@
           {
             "$ref": "#/components/schemas/CurrencyAttribute"
           },
-          {
-            "$ref": "#/components/schemas/RepeatableAttribute"
-          },
           {
             "$ref": "#/components/schemas/TagsAttribute"
           },
@@ -4416,6 +4477,18 @@
           },
           {
             "$ref": "#/components/schemas/PartnerOrganisationAttribute"
+          },
+          {
+            "$ref": "#/components/schemas/PhoneAttribute"
+          },
+          {
+            "$ref": "#/components/schemas/EmailAttribute"
+          },
+          {
+            "$ref": "#/components/schemas/PaymentAttribute"
+          },
+          {
+            "$ref": "#/components/schemas/PriceComponentAttribute"
           }
         ]
       },
@@ -4583,6 +4656,13 @@
                 "example": "top"
               }
             }
+          },
+          "repeatable": {
+            "description": "The attribute is a repeatable",
+            "type": "boolean"
+          },
+          "has_primary": {
+            "type": "boolean"
           }
         },
         "required": [
@@ -4610,6 +4690,18 @@
               },
               "rich_text": {
                 "type": "boolean"
+              },
+              "rows": {
+                "description": "Number of rows for rich_text textarea",
+                "oneOf": [
+                  {
+                    "type": "integer"
+                  },
+                  {
+                    "type": "string"
+                  }
+                ],
+                "example": 3
               }
             }
           }
@@ -4667,6 +4759,14 @@
                 "enum": [
                   "boolean"
                 ]
+              },
+              "display_type": {
+                "type": "string",
+                "enum": [
+                  "switch",
+                  "checkbox"
+                ],
+                "default": "switch"
               }
             }
           }
@@ -5106,6 +5206,19 @@
                 "default": false,
                 "description": "Enables the preview, edition, and creation of relation items on a Master-Details view mode."
               },
+              "relation_picker_filter": {
+                "description": "Additional entity search filter for relation picker",
+                "type": "object",
+                "properties": {
+                  "q": {
+                    "type": "string",
+                    "example": "AND is_composite_price:true"
+                  }
+                },
+                "required": [
+                  "q"
+                ]
+              },
               "actions": {
                 "type": "array",
                 "items": {
@@ -5140,12 +5253,13 @@
                       }
                     },
                     "new_entity_item": {
+                      "description": "Default field values for new entity to create",
+                      "nullable": true,
                       "type": "object",
-                      "allOf": [
-                        {
-                          "$ref": "#/components/schemas/EntityItem"
-                        }
-                      ]
+                      "additionalProperties": true,
+                      "example": {
+                        "_schema": "order"
+                      }
                     }
                   }
                 },
@@ -5213,6 +5327,11 @@
               "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."
+              },
+              "repeatable": {
+                "description": "Relations are always repeatables",
+                "type": "boolean",
+                "default": true
               }
             }
           }
@@ -5454,33 +5573,6 @@
               },
               "has_primary": {
                 "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",
-                  "strong"
-                ]
-              },
-              "type": {
-                "type": "string",
-                "enum": [
-                  "string",
-                  "phone",
-                  "email",
-                  "address",
-                  "relation",
-                  "payment",
-                  "price_component",
-                  "date",
-                  "message_email_address"
-                ]
-              },
-              "enable_relation_picker": {
-                "type": "boolean",
-                "default": true,
-                "description": "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."
               }
             }
           }
@@ -5547,7 +5639,6 @@
             },
             "required": [
               "type",
-              "address",
               "name"
             ]
           }
@@ -5631,6 +5722,82 @@
           }
         ]
       },
+      "EmailAttribute": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseAttribute"
+          },
+          {
+            "type": "object",
+            "description": "Email address",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "email"
+                ]
+              }
+            }
+          }
+        ]
+      },
+      "PhoneAttribute": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseAttribute"
+          },
+          {
+            "type": "object",
+            "description": "Phone number",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "phone"
+                ]
+              }
+            }
+          }
+        ]
+      },
+      "PaymentAttribute": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseAttribute"
+          },
+          {
+            "type": "object",
+            "description": "Payment method",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "payment"
+                ]
+              }
+            }
+          }
+        ]
+      },
+      "PriceComponentAttribute": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseAttribute"
+          },
+          {
+            "type": "object",
+            "description": "Price component",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "price_component"
+                ]
+              }
+            }
+          }
+        ]
+      },
       "ComputedAttribute": {
         "allOf": [
           {
@@ -5645,8 +5812,33 @@
                 "enum": [
                   "computed"
                 ]
+              },
+              "computed": {
+                "type": "boolean",
+                "default": true
+              },
+              "value_formatter": {
+                "type": "string",
+                "description": "Variable template used to format the computed value",
+                "example": "{{formatCurrencyAttribute entity attribute locale}}"
+              },
+              "preview_value_formatter": {
+                "type": "string",
+                "description": "Variable template used to format a preview for the computed value",
+                "example": "{{formatCurrencyAttribute entity attribute locale}}"
+              },
+              "amount_field": {
+                "type": "string",
+                "description": "A source amount field that is used to compute the value of the attribute"
+              },
+              "currency_field": {
+                "type": "string",
+                "description": "A currency field used to format a computed currency value"
               }
-            }
+            },
+            "required": [
+              "value_formatter"
+            ]
           }
         ]
       },
@@ -7593,6 +7785,16 @@
           "comment"
         ]
       },
+      "TaxonomySearchIncludeArchivedParam": {
+        "type": "string",
+        "enum": [
+          "true",
+          "false",
+          "only"
+        ],
+        "description": "Whether to include archived labels in the search results\n- `true`: include archived labels\n- `false`: exclude archived labels\n- `only`: include only archived labels\n\nBy default, no archived labels are included in the search results.\n",
+        "default": "false"
+      },
       "TaxonomyClassification": {
         "type": "object",
         "properties": {
@@ -7718,6 +7920,7 @@
         "type": "string",
         "enum": [
           "MOVE_CLASSIFICATIONS",
+          "MERGE_CLASSIFICATIONS",
           "DELETE_CLASSIFICATIONS"
         ]
       },
@@ -7731,6 +7934,9 @@
           "job_status": {
             "$ref": "#/components/schemas/TaxonomyBulkJobStatus"
           },
+          "failure_reason": {
+            "type": "string"
+          },
           "action_type": {
             "$ref": "#/components/schemas/TaxonomyBulkJobActionType"
           },
@@ -7740,6 +7946,9 @@
               "target_taxonomy": {
                 "$ref": "#/components/schemas/TaxonomySlug"
               },
+              "target_classification": {
+                "$ref": "#/components/schemas/ClassificationId"
+              },
               "classification_ids": {
                 "type": "array",
                 "items": {

package/package.json

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