@epilot/customer-portal-client 0.35.0 → 0.37.0

package/src/openapi.json

@@ -137,6 +137,7 @@
         "operationId": "createUser",
         "summary": "createUser",
         "description": "Registers a portal user",
+        "deprecated": true,
         "security": [],
         "tags": [
           "Public"
@@ -199,7 +200,7 @@
       "post": {
         "operationId": "createUserV3",
         "summary": "createUserV3",
-        "description": "Registers a portal user with portal id",
+        "description": "Registers a portal user.\nSupports two identification methods:\n1. Using portal_id\n2. Using domain\n",
         "security": [],
         "tags": [
           "Public"
@@ -208,11 +209,20 @@
           {
             "in": "query",
             "name": "portal_id",
-            "required": true,
+            "required": false,
             "schema": {
               "$ref": "#/components/schemas/PortalId"
             },
-            "description": "Origin of the portal"
+            "description": "Portal ID (required if domain is not provided)"
+          },
+          {
+            "in": "query",
+            "name": "domain",
+            "required": false,
+            "schema": {
+              "type": "string"
+            },
+            "description": "Portal domain for identification (alternative to portal_id)"
           }
         ],
         "requestBody": {
@@ -2160,6 +2170,68 @@
         }
       }
     },
+    "/v3/portal/public/widgets": {
+      "get": {
+        "operationId": "getPublicPortalWidgetsV3",
+        "summary": "getPublicPortalWidgetsV3",
+        "description": "Retrieves the public widgets of a portal.\nSupports two identification methods:\n1. Using org_id + portal_id\n2. Using domain\n",
+        "tags": [
+          "Public"
+        ],
+        "security": [],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "org_id",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "example": 12324
+            },
+            "description": "Organization ID (required if domain is not provided)"
+          },
+          {
+            "in": "query",
+            "name": "portal_id",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/PortalId"
+            },
+            "description": "Portal ID (required if domain is not provided)"
+          },
+          {
+            "in": "query",
+            "name": "domain",
+            "required": false,
+            "schema": {
+              "type": "string"
+            },
+            "description": "Portal domain for identification (alternative to org_id + portal_id)"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Retrieved the portal public widgets successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UpsertPortalWidget"
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
     "/v2/portal/widgets": {
       "post": {
         "operationId": "upsertPortalWidget",
@@ -2278,6 +2350,194 @@
         }
       }
     },
+    "/v3/portal/widgets": {
+      "get": {
+        "operationId": "getPortalWidgetsV3",
+        "summary": "getPortalWidgetsV3",
+        "description": "Retrieves the widgets of a portal by portal_id.",
+        "tags": [
+          "ECP Admin",
+          "ECP"
+        ],
+        "security": [
+          {
+            "EitherAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "portal_id",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/PortalId"
+            },
+            "description": "PortalId of the portal"
+          },
+          {
+            "in": "query",
+            "name": "contract_id",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/EntityId"
+            },
+            "description": "Contract context for widgets"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Retrieved the portal widgets successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UpsertPortalWidget"
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      },
+      "post": {
+        "operationId": "upsertPortalWidgetV3",
+        "summary": "upsertPortalWidgetV3",
+        "description": "Upsert widget for a portal by portal_id.",
+        "security": [
+          {
+            "EpilotAuth": []
+          }
+        ],
+        "tags": [
+          "ECP Admin"
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "portal_id",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/PortalId"
+            },
+            "description": "PortalId of the portal"
+          }
+        ],
+        "requestBody": {
+          "description": "Portal widgets payload",
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpsertPortalWidget"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Portal widget configuration upserted successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UpsertPortalWidget"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/InvalidRequest"
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
+    "/v3/portal/portal/files": {
+      "post": {
+        "operationId": "savePortalFilesV3",
+        "summary": "savePortalFilesV3",
+        "description": "Add files to portal by portal_id",
+        "tags": [
+          "ECP Admin"
+        ],
+        "security": [
+          {
+            "EpilotAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "portal_id",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/PortalId"
+            },
+            "description": "PortalId of the portal"
+          }
+        ],
+        "requestBody": {
+          "description": "portal files request",
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SavePortalFile"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "The files have been saved to the portal successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "createdFiles": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/File"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/InvalidRequest"
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFound"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
     "/v2/portal/replace-ecp-template-variables": {
       "post": {
         "operationId": "replaceECPTemplateVariables",
@@ -2551,6 +2811,76 @@
         }
       }
     },
+    "/v3/portal/public/schemas": {
+      "get": {
+        "operationId": "getPublicSchemasV3",
+        "summary": "getPublicSchemasV3",
+        "description": "Retrieves schemas by portal. Only schemas and attributes used on public pages are returned.\nSupports two identification methods:\n1. Using org_id + portal_id\n2. Using domain\n",
+        "tags": [
+          "Public"
+        ],
+        "security": [],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "org_id",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "example": 12324
+            },
+            "description": "Organization ID (required if domain is not provided)"
+          },
+          {
+            "in": "query",
+            "name": "portal_id",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/PortalId"
+            },
+            "description": "Portal ID (required if domain is not provided)"
+          },
+          {
+            "in": "query",
+            "name": "domain",
+            "required": false,
+            "schema": {
+              "type": "string"
+            },
+            "description": "Portal domain for identification (alternative to org_id + portal_id)"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Retrieved schemas for an organization successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "schemas": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/Schema"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
     "/v2/portal/public/org/settings": {
       "get": {
         "operationId": "getOrganizationSettingsByDomain",
@@ -3001,7 +3331,7 @@
       "post": {
         "operationId": "checkContactExistsV3",
         "summary": "checkContactExistsV3",
-        "description": "True if contact with given identifiers exists.",
+        "description": "True if contact with given identifiers exists.\nSupports two identification methods:\n1. Using portal_id\n2. Using domain\n",
         "security": [],
         "tags": [
           "Public"
@@ -3010,11 +3340,20 @@
           {
             "in": "query",
             "name": "portal_id",
-            "required": true,
+            "required": false,
             "schema": {
               "$ref": "#/components/schemas/PortalId"
             },
-            "description": "PortalId of the portal"
+            "description": "PortalId of the portal (required if domain is not provided)"
+          },
+          {
+            "in": "query",
+            "name": "domain",
+            "required": false,
+            "schema": {
+              "type": "string"
+            },
+            "description": "Portal domain for identification (alternative to portal_id)"
           }
         ],
         "requestBody": {
@@ -3617,7 +3956,7 @@
       "get": {
         "operationId": "userExistsV3",
         "summary": "userExistsV3",
-        "description": "Checks whether a user exists in the portal",
+        "description": "Checks whether a user exists in the portal.\nSupports two identification methods:\n1. Using org_id + portal_id\n2. Using domain\n",
         "tags": [
           "Public"
         ],
@@ -3636,10 +3975,10 @@
           {
             "in": "query",
             "name": "org_id",
-            "required": true,
+            "required": false,
             "schema": {
               "type": "string",
-              "description": "Organization ID",
+              "description": "Organization ID (required if domain is not provided)",
               "example": 123
             }
           },
@@ -3647,10 +3986,19 @@
             "in": "query",
             "name": "portal_id",
             "required": false,
-            "description": "Checkes if user exists in the given portal ID. If not provided, checks in all portals.",
+            "description": "Checks if user exists in the given portal ID. If not provided, checks in all portals.",
             "schema": {
               "$ref": "#/components/schemas/PortalId"
             }
+          },
+          {
+            "in": "query",
+            "name": "domain",
+            "required": false,
+            "schema": {
+              "type": "string"
+            },
+            "description": "Portal domain for identification (alternative to org_id + portal_id)"
           }
         ],
         "responses": {
@@ -6119,7 +6467,7 @@
       "post": {
         "operationId": "loginToPortalAsUser",
         "summary": "loginToPortalAsUser",
-        "description": "Generate a token to log in to a portal impersonating a users.\n\nToken is valid for 5 minutes.\n",
+        "description": "Generate a token to log in to a portal impersonating a users.\n\nToken is valid for 5 minutes.\n\nSupports three identification methods (at least one required):\n1. Using portal_id (takes precedence)\n2. Using domain\n3. Using origin (legacy)\n",
         "tags": [
           "ECP Admin"
         ],
@@ -6147,6 +6495,10 @@
                   "portal_id": {
                     "type": "string",
                     "description": "The portal ID to look up the portal config. When provided, takes precedence over origin."
+                  },
+                  "domain": {
+                    "type": "string",
+                    "description": "Portal domain for identification. Alternative to portal_id or origin."
                   }
                 }
               }
@@ -6241,7 +6593,7 @@
       "post": {
         "operationId": "triggerEntityAccessEventV3",
         "summary": "triggerEntityAccessEventV3",
-        "description": "Trigger entity access event for a portal user",
+        "description": "Trigger entity access event for a portal user.\nSupports two identification methods:\n1. Using portal_id\n2. Using domain\n",
         "tags": [
           "ECP"
         ],
@@ -6273,11 +6625,20 @@
           {
             "name": "portal_id",
             "in": "query",
-            "required": true,
-            "description": "Portal ID",
+            "required": false,
+            "description": "Portal ID (required if domain is not provided)",
             "schema": {
               "$ref": "#/components/schemas/PortalId"
             }
+          },
+          {
+            "name": "domain",
+            "in": "query",
+            "required": false,
+            "description": "Portal domain for identification (alternative to portal_id)",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -6772,7 +7133,7 @@
     "/v2/portal/metering/reading/allowed-range/{meter_id}": {
       "get": {
         "operationId": "getAllowedMeterReadingRange",
-        "description": "Get allowed reading range for all counters of a meter from the configured \nthird-party plausibility check hook using 'range' mode. This endpoint requires \na plausibility check hook to be configured for the portal.\n",
+        "description": "Get allowed reading range for all counters of a meter from the configured\nthird-party plausibility check hook using 'range' mode. This endpoint requires\na plausibility check hook to be configured for the portal.\n",
         "tags": [
           "ECP"
         ],
@@ -6957,7 +7318,7 @@
       "post": {
         "operationId": "ssoLoginV3",
         "summary": "ssoLoginV3",
-        "description": "Initiate login using external SSO identity.\n\nVerifies the user with the issuer and matches the identity to an epilot user (or creates a new user).\n\nReturns parameters to be used with CUSTOM_AUTH flow against Cognito\n",
+        "description": "Initiate login using external SSO identity.\n\nVerifies the user with the issuer and matches the identity to an epilot user (or creates a new user).\n\nReturns parameters to be used with CUSTOM_AUTH flow against Cognito.\n\nSupports two identification methods:\n1. Using org_id + portal_id\n2. Using domain\n",
         "security": [
           {
             "ExternalOIDCAuth": []
@@ -6967,8 +7328,8 @@
           {
             "in": "query",
             "name": "portal_id",
-            "required": true,
-            "description": "ID of the Portal",
+            "required": false,
+            "description": "ID of the Portal (required if domain is not provided)",
             "schema": {
               "$ref": "#/components/schemas/PortalId"
             }
@@ -6976,13 +7337,22 @@
           {
             "in": "query",
             "name": "org_id",
-            "description": "epilot organization id",
-            "required": true,
+            "description": "epilot organization id (required if domain is not provided)",
+            "required": false,
             "schema": {
               "type": "string",
               "example": 123
             }
           },
+          {
+            "in": "query",
+            "name": "domain",
+            "description": "Portal domain for identification (alternative to org_id + portal_id)",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "in": "query",
             "name": "contact_id",
@@ -9699,6 +10069,14 @@
             "type": "boolean",
             "description": "Mark true if the domain is an Epilot domain"
           },
+          "epilot_domain": {
+            "type": "string",
+            "description": "The URL on which the portal is accessible",
+            "example": "example-portal-12345.ecp.epilot.cloud"
+          },
+          "domain_settings": {
+            "$ref": "#/components/schemas/DomainSettings"
+          },
           "design_id": {
             "$ref": "#/components/schemas/EntityId",
             "description": "ID of the design used to build the portal"
@@ -10247,6 +10625,24 @@
           }
         }
       },
+      "DomainSettings": {
+        "type": "object",
+        "description": "Domain settings for the portal",
+        "properties": {
+          "is_custom_domain_enabled": {
+            "type": "boolean",
+            "description": "Whether the custom domain is enabled"
+          },
+          "is_epilot_domain_enabled": {
+            "type": "boolean",
+            "description": "Whether the Epilot domain is enabled"
+          },
+          "is_redirection_enabled": {
+            "type": "boolean",
+            "description": "Whether the redirection is enabled"
+          }
+        }
+      },
       "WidgetBase": {
         "type": "object",
         "required": [
@@ -11008,8 +11404,45 @@
       },
       "Entity": {
         "type": "object",
-        "properties": {},
-        "additionalProperties": true
+        "additionalProperties": true,
+        "properties": {
+          "templates_output_highlighted": {
+            "type": "object",
+            "readOnly": true,
+            "description": "Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.",
+            "additionalProperties": {
+              "oneOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string"
+                  }
+                }
+              ]
+            }
+          },
+          "search_snippets": {
+            "type": "array",
+            "readOnly": true,
+            "description": "Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.",
+            "items": {
+              "type": "object",
+              "properties": {
+                "field": {
+                  "type": "string",
+                  "description": "Human-readable field label"
+                },
+                "fragment": {
+                  "type": "string",
+                  "description": "Highlighted text fragment with <em> tags"
+                }
+              }
+            }
+          }
+        }
       },
       "EntityTemplates": {
         "type": "object",
@@ -12712,6 +13145,10 @@
             "example": [
               "active_workflow"
             ]
+          },
+          "highlight": {
+            "type": "object",
+            "description": "Elasticsearch highlight configuration passed through to the Entity API. When provided, matching results include a `highlight` object with field names as keys and arrays of highlighted fragments as values."
           }
         },
         "required": [
@@ -13956,7 +14393,7 @@
           "timestamp": {
             "type": "string",
             "description": "If the value is not provided, the system will be set with the time the request is processed.",
-            "example": "2022-10-10"
+            "example": "2022-10-10T00:00:00.000Z"
           },
           "source": {
             "$ref": "#/components/schemas/Source",
@@ -14786,6 +15223,11 @@
                 "format": "date-time",
                 "description": "Last modified timestamp of the Page",
                 "example": "2021-02-09T12:41:43.662Z"
+              },
+              "portal_id": {
+                "type": "string",
+                "description": "The id of the portal",
+                "example": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
               }
             }
           }
@@ -14812,6 +15254,14 @@
             "type": "boolean",
             "description": "Mark true if the domain is an Epilot domain"
           },
+          "epilot_domain": {
+            "type": "string",
+            "description": "The Epilot domain on which the portal is accessible",
+            "example": "example-portal-1.ecp.epilot.io"
+          },
+          "domain_settings": {
+            "$ref": "#/components/schemas/DomainSettings"
+          },
           "design_id": {
             "$ref": "#/components/schemas/EntityId",
             "description": "ID of the design used to build the portal"
@@ -15368,6 +15818,11 @@
           "is_canary": {
             "type": "boolean",
             "description": "Whether the org is in canary mode"
+          },
+          "redirect_to": {
+            "type": "string",
+            "description": "The URL to redirect to",
+            "example": "https://example.com"
           }
         }
       },