@epilot/sdk 2.4.2 → 2.4.4-alpha.0

package/definitions/customer-portal.json

@@ -828,6 +828,11 @@
                               "min"
                             ],
                             "example": "sum"
+                          },
+                          "unit": {
+                            "type": "string",
+                            "description": "Optional unit of the consumption value. Defaults to unit present on the relevant Meter Counter.",
+                            "example": "kWh"
                           }
                         },
                         "required": [
@@ -10804,6 +10809,14 @@
           "widgets"
         ],
         "properties": {
+          "portal_sk_v3": {
+            "type": "string",
+            "description": "V3 portal-scoped storage key for the widget configuration"
+          },
+          "is_v3_item": {
+            "type": "boolean",
+            "description": "Indicates whether the widget configuration is stored as a V3 portal-scoped item"
+          },
           "widgets": {
             "type": "array",
             "items": {
@@ -14672,6 +14685,11 @@
             "example": [
               "00123456"
             ]
+          },
+          "file_id": {
+            "type": "string",
+            "description": "ID of the created file entity for the uploaded photo.",
+            "example": "abc123def456"
           }
         }
       },
@@ -15397,6 +15415,17 @@
                 "type": "string",
                 "description": "The id of the portal",
                 "example": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
+              },
+              "past_routes": {
+                "type": "array",
+                "description": "Slugs that previously belonged to this page. The portal redirects requests for these slugs to the current slug. Managed by the server: when a page's slug changes, the old slug is appended here, and when another page claims one of these slugs it is removed from this list.\n",
+                "items": {
+                  "type": "string"
+                },
+                "example": [
+                  "old-dashboard",
+                  "home"
+                ]
               }
             }
           }

package/definitions/notes.json

@@ -1,9 +1,13 @@
 {
   "openapi": "3.0.2",
   "info": {
-    "version": "2.3.0",
+    "version": "2.4.0",
     "title": "Notes API",
-    "description": "Facade API Backend for Epilot Notes feature"
+    "description": "Facade API Backend for Epilot Notes feature",
+    "contact": {
+      "name": "epilot",
+      "url": "https://docs.epilot.io"
+    }
   },
   "servers": [
     {
@@ -16,6 +20,9 @@
     },
     {
       "name": "Pinning"
+    },
+    {
+      "name": "Reactions"
     }
   ],
   "security": [
@@ -675,30 +682,33 @@
             "format": "date-time"
           },
           "created_by": {
-            "type": "object",
-            "properties": {
-              "type": {
-                "$ref": "#/components/schemas/CreatedByType"
-              },
-              "user_id": {
-                "type": "string"
-              },
-              "display_name": {
-                "type": "string"
-              },
-              "org_id": {
-                "type": "string"
-              },
-              "email": {
-                "type": "string"
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "$ref": "#/components/schemas/CreatedByType"
+                },
+                "user_id": {
+                  "type": "string"
+                },
+                "display_name": {
+                  "type": "string"
+                },
+                "org_id": {
+                  "type": "string"
+                },
+                "email": {
+                  "type": "string"
+                },
+                "phone": {
+                  "type": "string"
+                }
               },
-              "phone": {
-                "type": "string"
-              }
-            },
-            "required": [
-              "type"
-            ]
+              "required": [
+                "type"
+              ]
+            }
           },
           "read_by": {
             "type": "array",
@@ -873,30 +883,33 @@
             "format": "date-time"
           },
           "created_by": {
-            "type": "object",
-            "properties": {
-              "type": {
-                "$ref": "#/components/schemas/CreatedByType"
-              },
-              "user_id": {
-                "type": "string"
-              },
-              "display_name": {
-                "type": "string"
-              },
-              "org_id": {
-                "type": "string"
-              },
-              "email": {
-                "type": "string"
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "$ref": "#/components/schemas/CreatedByType"
+                },
+                "user_id": {
+                  "type": "string"
+                },
+                "display_name": {
+                  "type": "string"
+                },
+                "org_id": {
+                  "type": "string"
+                },
+                "email": {
+                  "type": "string"
+                },
+                "phone": {
+                  "type": "string"
+                }
               },
-              "phone": {
-                "type": "string"
-              }
-            },
-            "required": [
-              "type"
-            ]
+              "required": [
+                "type"
+              ]
+            }
           },
           "read_by": {
             "type": "array",
@@ -984,35 +997,43 @@
             "description": "The timestamp of when this Note was pinned",
             "format": "date-time"
           },
+          "edited_at": {
+            "type": "string",
+            "description": "The timestamp of when this Note was last updated",
+            "format": "date-time"
+          },
           "created_by": {
-            "type": "object",
-            "properties": {
-              "type": {
-                "type": "string",
-                "enum": [
-                  "user",
-                  "group"
-                ]
-              },
-              "user_id": {
-                "type": "string"
-              },
-              "display_name": {
-                "type": "string"
-              },
-              "org_id": {
-                "type": "string"
-              },
-              "email": {
-                "type": "string"
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "enum": [
+                    "user",
+                    "group"
+                  ]
+                },
+                "user_id": {
+                  "type": "string"
+                },
+                "display_name": {
+                  "type": "string"
+                },
+                "org_id": {
+                  "type": "string"
+                },
+                "email": {
+                  "type": "string"
+                },
+                "phone": {
+                  "type": "string"
+                }
               },
-              "phone": {
-                "type": "string"
-              }
-            },
-            "required": [
-              "type"
-            ]
+              "required": [
+                "type"
+              ]
+            }
           },
           "read_by": {
             "type": "array",
@@ -1119,35 +1140,43 @@
             "description": "The timestamp of when this Note was pinned",
             "format": "date-time"
           },
+          "edited_at": {
+            "type": "string",
+            "description": "The timestamp of when this Note was last updated",
+            "format": "date-time"
+          },
           "created_by": {
-            "type": "object",
-            "properties": {
-              "type": {
-                "type": "string",
-                "enum": [
-                  "user",
-                  "group"
-                ]
-              },
-              "user_id": {
-                "type": "string"
-              },
-              "display_name": {
-                "type": "string"
-              },
-              "org_id": {
-                "type": "string"
-              },
-              "email": {
-                "type": "string"
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "enum": [
+                    "user",
+                    "group"
+                  ]
+                },
+                "user_id": {
+                  "type": "string"
+                },
+                "display_name": {
+                  "type": "string"
+                },
+                "org_id": {
+                  "type": "string"
+                },
+                "email": {
+                  "type": "string"
+                },
+                "phone": {
+                  "type": "string"
+                }
               },
-              "phone": {
-                "type": "string"
-              }
-            },
-            "required": [
-              "type"
-            ]
+              "required": [
+                "type"
+              ]
+            }
           },
           "read_by": {
             "type": "array",
@@ -1339,35 +1368,43 @@
             "description": "The timestamp of when this Note was pinned",
             "format": "date-time"
           },
+          "edited_at": {
+            "type": "string",
+            "description": "The timestamp of when this Note was last updated",
+            "format": "date-time"
+          },
           "created_by": {
-            "type": "object",
-            "properties": {
-              "type": {
-                "type": "string",
-                "enum": [
-                  "user",
-                  "group"
-                ]
-              },
-              "user_id": {
-                "type": "string"
-              },
-              "display_name": {
-                "type": "string"
-              },
-              "org_id": {
-                "type": "string"
-              },
-              "email": {
-                "type": "string"
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "enum": [
+                    "user",
+                    "group"
+                  ]
+                },
+                "user_id": {
+                  "type": "string"
+                },
+                "display_name": {
+                  "type": "string"
+                },
+                "org_id": {
+                  "type": "string"
+                },
+                "email": {
+                  "type": "string"
+                },
+                "phone": {
+                  "type": "string"
+                }
               },
-              "phone": {
-                "type": "string"
-              }
-            },
-            "required": [
-              "type"
-            ]
+              "required": [
+                "type"
+              ]
+            }
           },
           "read_by": {
             "type": "array",
@@ -1407,7 +1444,15 @@
                 "type",
                 "id"
               ]
-            }
+            },
+            "minItems": 1
+          },
+          "include_related_schemas": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "When set, the API resolves related entities of these schemas for the primary entity context and includes their notes in the results."
           },
           "from": {
             "type": "number",

package/definitions/pricing-runtime.json

@@ -1 +1 @@
-{"s":"https://pricing-api.sls.epilot.io","o":[["$calculatePricingDetails","post","/v1/pricing:compute",null,1],["createOrder","post","/v1/order",null,1],["putOrder","put","/v1/order/{id}",[["id","p",true]],1],["$checkoutCart","post","/v1/public/cart:checkout",[["X-Ivy-Org-ID","h",true]],1],["$searchCatalog","post","/v1/public/catalog",[["X-Ivy-Org-ID","h"],["Authorization","h"]],1],["$privateSearchCatalog","post","/v1/catalog",null,1],["$validatePromoCodes","post","/v1/public/validate-promo-codes",[["X-Ivy-Org-ID","h",true]],1],["$availabilityCheck","post","/v1/public/availability:check",[["X-Ivy-Org-ID","h",true]],1],["$validateAvailabilityFile","get","/v1/validate-availability/{id}",[["id","p",true],["X-Epilot-Org-ID","h",true]]],["$historicMarketPrices","get","/v1/public/historicMarketPrices",[["market","q",true],["bidding_zone","q",true],["frequency","q",true],["from","q",true],["to","q",true]]],["$averageMarketPrice","get","/v1/public/averageMarketPrice",[["market","q",true],["bidding_zone","q",true],["from","q",true],["to","q",true]]],["$searchExternalProducts","post","/v1/public/integration/{integrationId}/products",[["integrationId","p",true]],1],["$searchExternalProductRecommendations","post","/v1/public/integration/{integrationId}/product-recommendations",[["integrationId","p",true]],1],["$searchProviders","post","/v1/public/integration/{integrationId}/providers:search",[["X-Epilot-Org-ID","h",true],["integrationId","p",true]],1],["$searchStreets","post","/v1/public/integration/{integrationId}/streets:search",[["X-Epilot-Org-ID","h",true],["integrationId","p",true]],1],["$computePrice","post","/v1/public/integration/{integrationId}/compute-price",[["X-Epilot-Org-ID","h",true],["integrationId","p",true]],1],["$getCredentials","get","/v1/integration/{integrationId}/credentials",[["integrationId","p",true]]],["$saveCredentials","put","/v1/integration/{integrationId}/credentials:save",[["integrationId","p",true]],1],["$deleteCredentials","delete","/v1/integration/{integrationId}/credentials:delete",[["integrationId","p",true]]],["$getExternalCatalogProducts","post","/v1/public/external-catalog/products",null,1],["$getExternalCatalogProductRecommendations","post","/v1/public/external-catalog/product-recommendations",null,1],["$productRecommendations","post","/v1/public/product-recommendations",[["X-Ivy-Org-ID","h"]],1]],"v":"3.0.3"}
+{"s":"https://pricing-api.sls.epilot.io","o":[["$calculatePricingDetails","post","/v1/pricing:compute",null,1],["createOrder","post","/v1/order",null,1],["putOrder","put","/v1/order/{id}",[["id","p",true]],1],["$checkoutCart","post","/v1/public/cart:checkout",[["X-Ivy-Org-ID","h",true]],1],["$searchCatalog","post","/v1/public/catalog",[["X-Ivy-Org-ID","h"],["Authorization","h"]],1],["$privateSearchCatalog","post","/v1/catalog",null,1],["$validatePromoCodes","post","/v1/public/validate-promo-codes",[["X-Ivy-Org-ID","h",true]],1],["$availabilityCheck","post","/v1/public/availability:check",[["X-Ivy-Org-ID","h",true]],1],["$validateAvailabilityFile","get","/v1/validate-availability/{id}",[["id","p",true],["X-Epilot-Org-ID","h",true]]],["$historicMarketPrices","get","/v1/public/historicMarketPrices",[["market","q",true],["bidding_zone","q",true],["frequency","q",true],["from","q",true],["to","q",true]]],["$averageMarketPrice","get","/v1/public/averageMarketPrice",[["market","q",true],["bidding_zone","q",true],["from","q",true],["to","q",true]]],["$searchExternalProducts","post","/v1/public/integration/{integrationId}/products",[["integrationId","p",true]],1],["$searchExternalProductRecommendations","post","/v1/public/integration/{integrationId}/product-recommendations",[["integrationId","p",true]],1],["$searchProviders","post","/v1/public/integration/{integrationId}/providers:search",[["X-Epilot-Org-ID","h",true],["integrationId","p",true]],1],["$searchStreets","post","/v1/public/integration/{integrationId}/streets:search",[["X-Epilot-Org-ID","h",true],["integrationId","p",true]],1],["$computePrice","post","/v1/public/integration/{integrationId}/compute-price",[["X-Epilot-Org-ID","h",true],["integrationId","p",true]],1],["$getCredentials","get","/v1/integration/{integrationId}/credentials",[["integrationId","p",true]]],["$saveCredentials","put","/v1/integration/{integrationId}/credentials:save",[["integrationId","p",true]],1],["$deleteCredentials","delete","/v1/integration/{integrationId}/credentials:delete",[["integrationId","p",true]]],["$getExternalCatalogProducts","post","/v1/public/external-catalog/products",[["x-epilot-org-id","h"]],1],["$getExternalCatalogProductRecommendations","post","/v1/public/external-catalog/product-recommendations",[["x-epilot-org-id","h"]],1],["$productRecommendations","post","/v1/public/product-recommendations",[["X-Ivy-Org-ID","h"]],1]],"v":"3.0.3"}