@epilot/entity-client 4.34.1 → 4.34.3

package/dist/openapi.json

@@ -119,6 +119,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -1074,6 +1077,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
@@ -1167,6 +1173,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -1508,6 +1517,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
@@ -1548,6 +1560,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
@@ -1639,6 +1654,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
@@ -1731,6 +1749,9 @@
                 ]
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -1794,6 +1815,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -1850,6 +1874,9 @@
         "responses": {
           "204": {
             "description": "Relations deleted with success."
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
@@ -1916,6 +1943,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
@@ -1976,6 +2006,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
@@ -2009,6 +2042,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
@@ -2087,6 +2123,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -2132,6 +2171,9 @@
         "responses": {
           "204": {
             "description": "Relation deleted with success."
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
@@ -2347,6 +2389,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -2384,6 +2429,40 @@
           }
         }
       },
+      "patch": {
+        "operationId": "patchSavedView",
+        "summary": "patchSavedView",
+        "description": "Partially updates a saved view with the provided payload. If an updated_at is passed and the server contains a newer version of the view a `409` error is returned",
+        "tags": [
+          "Saved Views"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/SavedViewIdPathParam"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SavedViewPartial"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SavedViewItem"
+                }
+              }
+            }
+          }
+        }
+      },
       "delete": {
         "operationId": "deleteSavedView",
         "summary": "deleteSavedView",
@@ -2529,6 +2608,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -2645,6 +2727,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
@@ -2674,7 +2759,7 @@
             }
           },
           "404": {
-            "description": "Taxonomy classification not found"
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -3043,7 +3128,7 @@
       "post": {
         "operationId": "bulkDeleteClassifications",
         "summary": "bulkDeleteClassifications",
-        "description": "Permanently deletes taxonomy classifications. The classifications are deleted through a bulk \nasync operation which also deletes all references of the deleted classifications from the entities \nreferencing them.\n",
+        "description": "Permanently deletes taxonomy classifications. The classifications are deleted through a bulk\nasync operation which also deletes all references of the deleted classifications from the entities\nreferencing them.\n",
         "tags": [
           "Taxonomy"
         ],
@@ -3153,6 +3238,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -3294,6 +3382,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -3435,6 +3526,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -3576,6 +3670,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
           }
         }
       },
@@ -3737,16 +3834,7 @@
           },
           "category": {
             "type": "string",
-            "example": "customer_relations",
-            "enum": [
-              "customer_relations",
-              "sales",
-              "product_hub",
-              "contracts",
-              "journeys",
-              "messaging",
-              "system"
-            ]
+            "example": "customer_relations"
           },
           "published": {
             "type": "boolean",
@@ -3843,6 +3931,19 @@
                     "items": {
                       "$ref": "#/components/schemas/EntityAction"
                     }
+                  },
+                  "ui_config": {
+                    "type": "object",
+                    "properties": {
+                      "content_direction": {
+                        "type": "string",
+                        "enum": [
+                          "row",
+                          "column"
+                        ],
+                        "description": "Show attributes in a row or column"
+                      }
+                    }
                   }
                 }
               },
@@ -4267,6 +4368,9 @@
           {
             "$ref": "#/components/schemas/TagsAttribute"
           },
+          {
+            "$ref": "#/components/schemas/MessageEmailAddressAttribute"
+          },
           {
             "$ref": "#/components/schemas/NumberAttribute"
           },
@@ -5146,6 +5250,38 @@
           }
         ]
       },
+      "DefaultAddressFields": {
+        "type": "array",
+        "description": "Default fields visible on addresses",
+        "items": {
+          "type": "string",
+          "enum": [
+            "postal_code",
+            "city",
+            "street",
+            "street_number",
+            "plot_area",
+            "plot_of_land",
+            "suburb",
+            "country",
+            "additional_info",
+            "coordinates",
+            "start_date",
+            "end_date",
+            "salutation",
+            "title",
+            "first_name",
+            "last_name",
+            "company_name"
+          ]
+        },
+        "default": [
+          "postal_code",
+          "city",
+          "street",
+          "street_number"
+        ]
+      },
       "AddressAttribute": {
         "allOf": [
           {
@@ -5162,36 +5298,7 @@
                 ]
               },
               "default_address_fields": {
-                "description": "Default fields visible on addresses",
-                "default": [
-                  "postal_code",
-                  "city",
-                  "street",
-                  "street_number"
-                ],
-                "type": "array",
-                "items": {
-                  "type": "string",
-                  "enum": [
-                    "postal_code",
-                    "city",
-                    "street",
-                    "street_number",
-                    "plot_area",
-                    "plot_of_land",
-                    "suburb",
-                    "country",
-                    "additional_info",
-                    "coordinates",
-                    "start_date",
-                    "end_date",
-                    "salutation",
-                    "title",
-                    "first_name",
-                    "last_name",
-                    "company_name"
-                  ]
-                }
+                "$ref": "#/components/schemas/DefaultAddressFields"
               }
             }
           }
@@ -5214,6 +5321,9 @@
               },
               "has_primary": {
                 "type": "boolean"
+              },
+              "default_address_fields": {
+                "$ref": "#/components/schemas/DefaultAddressFields"
               }
             }
           }
@@ -5353,7 +5463,8 @@
                   "relation",
                   "payment",
                   "price_component",
-                  "date"
+                  "date",
+                  "message_email_address"
                 ]
               },
               "enable_relation_picker": {
@@ -5396,6 +5507,42 @@
           }
         ]
       },
+      "MessageEmailAddressAttribute": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseAttribute"
+          },
+          {
+            "type": "object",
+            "description": "Message emil address",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "message_email_address"
+                ]
+              },
+              "address": {
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              },
+              "send_status": {
+                "type": "string"
+              },
+              "email_type": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "type",
+              "address",
+              "name"
+            ]
+          }
+        ]
+      },
       "NumberAttribute": {
         "allOf": [
           {
@@ -5546,6 +5693,36 @@
             "items": {
               "$ref": "#/components/schemas/SettingFlag"
             }
+          },
+          "display_mode": {
+            "type": "string",
+            "enum": [
+              "inline",
+              "block"
+            ],
+            "description": "Defines the display mode of the summary attribute.\nWhen set to `inline`, the label and value will be displayed in the same line.\nWhen set to `block`, the label and value will be displayed in separate lines.\n"
+          },
+          "content_line_cap": {
+            "type": "number",
+            "description": "Defines the line numbers of the content.\nFor instance, When set to 1, the content will be displayed in a single line.\n"
+          },
+          "content_wrap": {
+            "type": "string",
+            "enum": [
+              "normal",
+              "nowrap",
+              "pre",
+              "pre-wrap"
+            ],
+            "description": "Defines white-space of the content.\n"
+          },
+          "hide_label": {
+            "type": "boolean",
+            "description": "When set to true, will hide the label of the field."
+          },
+          "highlight_container": {
+            "type": "boolean",
+            "description": "When set to true, will highlight the container of the field."
           }
         },
         "required": [
@@ -6486,6 +6663,10 @@
           "entity_id": {
             "$ref": "#/components/schemas/EntityId"
           },
+          "org_id": {
+            "type": "string",
+            "description": "Organization Id the entity belongs to"
+          },
           "attribute": {
             "type": "string"
           },
@@ -6536,9 +6717,7 @@
               "hydrate": {},
               "fields": {},
               "aggs": {},
-              "include_deleted": {
-                "$ref": "#/components/schemas/EntitySearchIncludeDeletedParam"
-              }
+              "include_deleted": {}
             },
             "additionalProperties": false,
             "required": [
@@ -6568,7 +6747,8 @@
               "size": {},
               "hydrate": {},
               "fields": {},
-              "aggs": {}
+              "aggs": {},
+              "include_deleted": {}
             },
             "additionalProperties": false,
             "required": [
@@ -7192,7 +7372,7 @@
           }
         ]
       },
-      "SavedView": {
+      "SavedViewPartial": {
         "description": "A saved entity view",
         "type": "object",
         "properties": {
@@ -7216,6 +7396,7 @@
             "example": "66"
           },
           "shared": {
+            "deprecated": true,
             "description": "boolean property for if a view is shared with organisation",
             "type": "boolean",
             "example": true
@@ -7273,13 +7454,32 @@
                 }
               }
             }
+          },
+          "shared_with": {
+            "type": "array",
+            "description": "List of users ('${userId}'), user groups ('group_${groupId}'), or partner users ('${partnerOrgId}_${partnerUserId}') that the view is shared with",
+            "items": {
+              "type": "string",
+              "example": "112233"
+            }
+          }
+        }
+      },
+      "SavedView": {
+        "description": "A saved entity view",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/SavedViewPartial"
+          },
+          {
+            "type": "object",
+            "required": [
+              "slug",
+              "name",
+              "created_by",
+              "ui_config"
+            ]
           }
-        },
-        "required": [
-          "slug",
-          "name",
-          "created_by",
-          "ui_config"
         ]
       },
       "Taxonomy": {
@@ -7619,6 +7819,22 @@
             "description": "Whether the setting should be enabled or not"
           }
         }
+      },
+      "ErrorObject": {
+        "description": "A generic error returned by the API",
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "integer",
+            "description": "The HTTP status code of the error",
+            "example": 400
+          },
+          "error": {
+            "type": "string",
+            "description": "The error message",
+            "example": "Bad Request"
+          }
+        }
       }
     },
     "parameters": {
@@ -8501,6 +8717,28 @@
           ]
         }
       }
+    },
+    "responses": {
+      "NotFoundError": {
+        "description": "The requested resource was not found",
+        "content": {
+          "application/json": {
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/ErrorObject"
+                },
+                {
+                  "example": {
+                    "status": 404,
+                    "error": "Not Found"
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
     }
   },
   "servers": [

package/dist/schema-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-model.js","sourceRoot":"","sources":["../src/schema-model.ts"],"names":[],"mappings":";;;AAAA,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B;;;OAGG;IACH,qCAAa,CAAA;IACb,yCAAiB,CAAA;AACnB,CAAC,EAPW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B"}

package/jest.config.ts

@@ -0,0 +1,16 @@
+import type { Config } from '@jest/types';
+
+const config: Config.InitialOptions = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/?(*.)+(spec|test).ts?(x)'],
+  testPathIgnorePatterns: ['node_modules'],
+  coveragePathIgnorePatterns: ['__tests__', 'node_modules'],
+  verbose: true,
+  silent: true,
+  moduleNameMapper: {
+    '^axios$': require.resolve('axios'),
+  },
+};
+
+export default config;