@epilot/customer-portal-client 0.47.0 → 0.47.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/customer-portal-client",
-  "version": "0.47.0",
+  "version": "0.47.1",
   "description": "API Client for epilot portal API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,6 +18,18 @@
     "sdk",
     "customer-portal"
   ],
+  "scripts": {
+    "test": "vitest",
+    "typescript": "tsc",
+    "bundle-definition": "webpack",
+    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/customer-portal.yaml",
+    "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
+    "build": "tsc && npm run build:patch && npm run bundle-definition",
+    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
+    "build:watch": "npm run build && tsc -w",
+    "prepublishOnly": "npm run typegen && npm run build",
+    "lint": "biome check src"
+  },
   "files": [
     "*.js",
     "*.d.ts",
@@ -55,16 +67,5 @@
     "typescript": "^4.1.3",
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"
-  },
-  "scripts": {
-    "test": "vitest",
-    "typescript": "tsc",
-    "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/customer-portal.yaml",
-    "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
-    "build": "tsc && npm run build:patch && npm run bundle-definition",
-    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
-    "build:watch": "npm run build && tsc -w",
-    "lint": "biome check src"
   }
-}
+}

package/src/openapi-runtime.json

@@ -2717,6 +2717,12 @@
         "responses": {}
       }
     },
+    "/v3/portal/configs/summaries": {
+      "get": {
+        "operationId": "listPortalConfigSummaries",
+        "responses": {}
+      }
+    },
     "/v3/portal/config/swap": {
       "post": {
         "operationId": "swapPortalConfig",

package/src/openapi.json

@@ -4036,7 +4036,7 @@
       "post": {
         "operationId": "identifyContact",
         "summary": "identifyContact",
-        "description": "Identify a contact by the portal's configured registration identifiers and, on a match,\nissue a short-lived bearer token that acts as that contact.\n\nResolution is identical to `checkContactExistsV3`. The token does not grant a portal\nsession; it is accepted only on the operations listed in `allowed_operations`, and\nexpires at `expires_at`. Requires `surface_id` to name a surface of the portal whose\n`authentication` is `registration_identifiers`; returns 403 otherwise. The token is\nconfined to that surface's data access. Requests may be rate limited (429).\n\nNo portal session is expected, but the caller must present a public access token\n(`token_type: journey` or `token_type: portal`) as the bearer, minted for the same\n`org_id`; the request is rejected with 401 otherwise. It binds the call to the journey\nor portal it comes from — the token is public, so it proves origin, not identity.\n",
+        "description": "Identify a contact by the surface's identifiers and, on a match, issue a short-lived\nbearer token that acts as that contact.\n\nThe identifiers checked are the surface's own `identifiers` when it configures any,\notherwise the portal's `registration_identifiers`. Their values are sent in the\n`registration_identifiers` request property. Resolution is otherwise identical to\n`checkContactExistsV3`: the same lookup, `registrationIdentifiersCheck` hook and\nTIMEOUT semantics, run on the surface's identifiers. The token does not grant a portal\nsession; it is accepted only on the operations listed in `allowed_operations`, and\nexpires at `expires_at`. Requires `surface_id` to name a surface of the portal whose\n`authentication` is `registration_identifiers`; returns 403 otherwise. The token is\nconfined to that surface's data access. Requests may be rate limited (429).\n\nNo portal session is expected, but the caller must present a public access token\n(`token_type: journey` or `token_type: portal`) as the bearer, minted for the same\n`org_id`; the request is rejected with 401 otherwise. It binds the call to the journey\nor portal it comes from — the token is public, so it proves origin, not identity.\n",
         "security": [],
         "tags": [
           "Public"
@@ -11115,6 +11115,50 @@
         }
       }
     },
+    "/v3/portal/configs/summaries": {
+      "get": {
+        "operationId": "listPortalConfigSummaries",
+        "summary": "listPortalConfigSummaries",
+        "description": "Lists the portals of the organization as lightweight summaries: the identifying,\ndisplay and registration fields of each portal config, without pages, email\ntemplates, grants, feature flags, identity providers or certificate details.\n\nUse it for portal overviews and pickers. Read a single portal with\n`getPortalConfigV3` when the full configuration is needed.\n",
+        "tags": [
+          "ECP Admin"
+        ],
+        "security": [
+          {
+            "EpilotAuth": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Portal config summaries retrieved successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "data": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/PortalConfigSummaryV3"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
     "/v3/portal/config/swap": {
       "post": {
         "operationId": "swapPortalConfig",
@@ -12477,6 +12521,42 @@
           }
         }
       },
+      "NewDesignMigrationResult": {
+        "type": "object",
+        "properties": {
+          "org_id": {
+            "type": "string"
+          },
+          "portal_id": {
+            "type": "string"
+          },
+          "origin": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "is_v3_item": {
+            "type": "boolean"
+          },
+          "dry_run": {
+            "type": "boolean"
+          },
+          "migrated": {
+            "type": "boolean",
+            "description": "True when the migration was written (false for dry_run)"
+          },
+          "summary": {
+            "type": "object",
+            "additionalProperties": true
+          },
+          "before": {
+            "type": "object",
+            "description": "Stored feature_settings and pages before the migration, for rollback",
+            "additionalProperties": true
+          }
+        }
+      },
       "OtaPortal": {
         "type": "object",
         "description": "A portal that has mobile OTA updates enabled.",
@@ -13069,37 +13149,7 @@
             "example": false
           },
           "feature_settings": {
-            "type": "object",
-            "description": "Feature settings for the portal",
-            "properties": {
-              "start_page": {
-                "type": "boolean",
-                "description": "Start page feature flag"
-              },
-              "billing": {
-                "type": "boolean",
-                "description": "Billing feature flag"
-              },
-              "change_due_date": {
-                "type": "boolean",
-                "description": "Change due date feature flag"
-              },
-              "new_design": {
-                "type": "boolean",
-                "description": "Enable or disable the new design for the portal"
-              },
-              "mcp_enabled": {
-                "type": "boolean",
-                "description": "Enable the MCP (AI agent) connector channel for this portal"
-              },
-              "mcp_grant_version": {
-                "type": "integer",
-                "minimum": 0,
-                "default": 0,
-                "readOnly": true,
-                "description": "Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled"
-              }
-            }
+            "$ref": "#/components/schemas/PortalFeatureSettings"
           },
           "accessToken": {
             "type": "string",
@@ -14104,7 +14154,7 @@
         }
       },
       "ContactIdentifyRequest": {
-        "description": "ContactExistsRequest plus the surface the token is requested for.\n",
+        "description": "ContactExistsRequest plus the surface the token is requested for. `registration_identifiers` carries the values of the surface's effective identifiers (keyed by schema, then attribute name): the surface's own `identifiers` when it configures any, otherwise the portal's `registration_identifiers`.\n",
         "allOf": [
           {
             "$ref": "#/components/schemas/ContactExistsRequest"
@@ -15703,7 +15753,7 @@
               "login",
               "registration_identifiers"
             ],
-            "description": "How a caller on this surface proves who they are.\n\n- `login`: a logged-in portal user token (the portal's own authentication).\n- `registration_identifiers`: the caller supplies the portal's\n  `registration_identifiers` to `identifyContact` and receives a short-lived\n  contact identification token. Anyone who knows or guesses those values can\n  use this surface, so its data access should be as narrow as the use case allows.\n\n`anonymous` (no proof of identity at all) is planned and not accepted yet.\n"
+            "description": "How a caller on this surface proves who they are.\n\n- `login`: a logged-in portal user token (the portal's own authentication).\n- `registration_identifiers`: the caller supplies the values of the surface's\n  identifiers (its own `identifiers`, or the portal's `registration_identifiers`\n  when it sets none) to `identifyContact` and receives a short-lived contact\n  identification token. Anyone who knows or guesses those values can use this\n  surface, so its data access should be as narrow as the use case allows.\n\n`anonymous` (no proof of identity at all) is planned and not accepted yet.\n"
           },
           "token_ttl_seconds": {
             "type": "integer",
@@ -15713,6 +15763,23 @@
             "maximum": 900,
             "description": "Lifetime of tokens minted for this surface. Only used with `registration_identifiers`."
           },
+          "identifiers": {
+            "type": "array",
+            "description": "Identifier attributes a caller must supply on this surface to be identified. Only\nused with `authentication: registration_identifiers`.\n\nOmitted or empty means the surface uses the portal's `registration_identifiers`.\nWhen set, these replace the portal's `registration_identifiers` on this surface\nonly: `identifyContact` requires a value for each of them (400 listing the missing\nones otherwise), runs the contact lookup and the `registrationIdentifiersCheck`\nhook on them, and refuses to issue tokens (403) unless there are at least two.\nEntries without `name` or `schema` are ignored.\n",
+            "items": {
+              "$ref": "#/components/schemas/RegistrationIdentifier"
+            },
+            "example": [
+              {
+                "name": "customer_number",
+                "schema": "contact"
+              },
+              {
+                "name": "meter_number",
+                "schema": "meter"
+              }
+            ]
+          },
           "data_access": {
             "$ref": "#/components/schemas/PortalSurfaceDataAccess"
           }
@@ -15839,6 +15906,123 @@
           }
         }
       },
+      "JourneyContextUsagesRequest": {
+        "type": "object",
+        "required": [
+          "journey_id",
+          "param_keys"
+        ],
+        "properties": {
+          "journey_id": {
+            "type": "string",
+            "description": "Journey whose context parameters are being looked up"
+          },
+          "param_keys": {
+            "type": "array",
+            "description": "Context parameter names (the `paramKey` of each parameter)",
+            "items": {
+              "type": "string"
+            }
+          },
+          "param_ids": {
+            "type": "array",
+            "description": "Accepted for a uniform adapter request shape; portals reference parameters by name only, so this is ignored.",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "JourneyContextUsagesResponse": {
+        "type": "object",
+        "required": [
+          "usages",
+          "status",
+          "scanned"
+        ],
+        "properties": {
+          "status": {
+            "type": "string",
+            "enum": [
+              "ok",
+              "partial"
+            ],
+            "description": "partial when the row cap, the soft deadline or a failed portal truncated the result"
+          },
+          "scanned": {
+            "type": "integer",
+            "description": "Portals examined"
+          },
+          "usages": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "kind",
+                "resource",
+                "location",
+                "matched_as"
+              ],
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "enum": [
+                    "portal-config",
+                    "portal-block",
+                    "portal-widget"
+                  ]
+                },
+                "resource": {
+                  "type": "object",
+                  "required": [
+                    "type",
+                    "id"
+                  ],
+                  "properties": {
+                    "type": {
+                      "type": "string",
+                      "enum": [
+                        "portal"
+                      ]
+                    },
+                    "id": {
+                      "type": "string"
+                    },
+                    "name": {
+                      "type": "string"
+                    }
+                  }
+                },
+                "location": {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                "matched_as": {
+                  "type": "object",
+                  "required": [
+                    "dialect",
+                    "token"
+                  ],
+                  "properties": {
+                    "dialect": {
+                      "type": "string",
+                      "enum": [
+                        "name"
+                      ]
+                    },
+                    "token": {
+                      "type": "string"
+                    },
+                    "at": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
       "ExternalLink": {
         "type": "object",
         "properties": {
@@ -20051,37 +20235,7 @@
             "example": false
           },
           "feature_settings": {
-            "type": "object",
-            "description": "Feature settings for the portal",
-            "properties": {
-              "start_page": {
-                "type": "boolean",
-                "description": "Start page feature flag"
-              },
-              "billing": {
-                "type": "boolean",
-                "description": "Billing feature flag"
-              },
-              "change_due_date": {
-                "type": "boolean",
-                "description": "Change due date feature flag"
-              },
-              "new_design": {
-                "type": "boolean",
-                "description": "Enable or disable the new design for the portal"
-              },
-              "mcp_enabled": {
-                "type": "boolean",
-                "description": "Enable the MCP (AI agent) connector channel for this portal"
-              },
-              "mcp_grant_version": {
-                "type": "integer",
-                "minimum": 0,
-                "default": 0,
-                "readOnly": true,
-                "description": "Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled"
-              }
-            }
+            "$ref": "#/components/schemas/PortalFeatureSettings"
           },
           "accessToken": {
             "type": "string",
@@ -20740,6 +20894,176 @@
           }
         ]
       },
+      "PortalFeatureSettings": {
+        "type": "object",
+        "description": "Feature settings for the portal",
+        "properties": {
+          "start_page": {
+            "type": "boolean",
+            "description": "Start page feature flag"
+          },
+          "billing": {
+            "type": "boolean",
+            "description": "Billing feature flag"
+          },
+          "change_due_date": {
+            "type": "boolean",
+            "description": "Change due date feature flag"
+          },
+          "new_design": {
+            "type": "boolean",
+            "description": "Enable or disable the new design for the portal"
+          },
+          "mcp_enabled": {
+            "type": "boolean",
+            "description": "Enable the MCP (AI agent) connector channel for this portal"
+          },
+          "mcp_grant_version": {
+            "type": "integer",
+            "minimum": 0,
+            "default": 0,
+            "readOnly": true,
+            "description": "Server-managed generation used to invalidate MCP grants after the connector is disabled or re-enabled"
+          }
+        }
+      },
+      "PortalConfigSummaryV3": {
+        "type": "object",
+        "description": "Lightweight view of a portal config for lists and pickers. Carries the identifying,\ndisplay and registration fields only. Pages, email templates, grants, feature flags,\nidentity providers and certificate details are left out; read them per portal with\n`getPortalConfigV3`.\n",
+        "properties": {
+          "portal_id": {
+            "$ref": "#/components/schemas/PortalId"
+          },
+          "organization_id": {
+            "type": "string",
+            "example": 12345,
+            "description": "ID of the organization"
+          },
+          "origin": {
+            "$ref": "#/components/schemas/Origin"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the portal"
+          },
+          "enabled": {
+            "type": "boolean",
+            "description": "Whether the portal is enabled"
+          },
+          "domain": {
+            "type": "string",
+            "description": "Custom domain of the portal"
+          },
+          "epilot_domain": {
+            "type": "string",
+            "description": "epilot-hosted domain of the portal"
+          },
+          "is_epilot_domain": {
+            "type": "boolean"
+          },
+          "dnsStatus": {
+            "type": "string",
+            "description": "Status of the custom domain setup, when a custom domain is configured",
+            "enum": [
+              "CONFIGURING",
+              "PENDING",
+              "SUCCEED",
+              "EXPIRED",
+              "NEW_CERT_IN_PROGRESS"
+            ]
+          },
+          "design_id": {
+            "$ref": "#/components/schemas/EntityId"
+          },
+          "default_user_to_notify": {
+            "type": "object",
+            "description": "Default 360 user to notify upon an internal notification",
+            "properties": {
+              "onPendingUser": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/AdminUser"
+                },
+                "description": "Default admin users for pending user notification to notify"
+              }
+            }
+          },
+          "feature_settings": {
+            "$ref": "#/components/schemas/PortalFeatureSettings"
+          },
+          "self_registration_setting": {
+            "type": "string",
+            "enum": [
+              "ALLOW_WITH_CONTACT_CREATION",
+              "ALLOW_WITHOUT_CONTACT_CREATION",
+              "DENY",
+              "ALWAYS_CREATE_CONTACT",
+              "DISALLOW_COMPLETELY",
+              "BLOCK_IF_PORTAL_USER_EXISTS"
+            ]
+          },
+          "self_registration_account_setting": {
+            "type": "string",
+            "enum": [
+              "ALLOW_WITH_CREATION",
+              "DENY",
+              "ALWAYS_CREATE",
+              "BLOCK_IF_PORTAL_USER_EXISTS",
+              "DISALLOW_COMPLETELY"
+            ]
+          },
+          "block_registration_if_portal_user_exists": {
+            "type": "boolean"
+          },
+          "self_registration_entity": {
+            "type": "string",
+            "description": "Entity type used as the primary identifier for self-registration",
+            "enum": [
+              "contact",
+              "account"
+            ]
+          },
+          "user_account_self_management": {
+            "type": "boolean",
+            "description": "Enable or disable user account self management"
+          },
+          "registration_identifiers": {
+            "type": "array",
+            "description": "Identifiers to identify a contact of a portal user during the registration.",
+            "items": {
+              "$ref": "#/components/schemas/ContractIdentifier"
+            }
+          },
+          "surfaces": {
+            "type": "array",
+            "description": "Surfaces this portal's data is reached from besides the portal UI itself.",
+            "items": {
+              "$ref": "#/components/schemas/PortalSurface"
+            }
+          },
+          "is_dummy": {
+            "type": "boolean"
+          },
+          "is_v3_item": {
+            "type": "boolean"
+          },
+          "published_revision_id": {
+            "type": "string",
+            "readOnly": true,
+            "description": "ID of the currently published revision, if the portal has been published"
+          },
+          "_created_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true
+          },
+          "_updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true
+          }
+        }
+      },
       "JuiceSettings": {
         "type": "object",
         "properties": {