@epilot/customer-portal-client 0.48.0 → 0.48.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/customer-portal-client",
-  "version": "0.48.0",
+  "version": "0.48.1",
   "description": "API Client for epilot portal API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/openapi-runtime.json

@@ -2460,6 +2460,18 @@
         "responses": {}
       }
     },
+    "/v3/portal/public/user/temporary-password/complete": {
+      "post": {
+        "operationId": "completeTemporaryPassword",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
     "/v2/portal/campaign/{campaign_id}/entity:status": {
       "put": {
         "operationId": "updateCampaignPortalBlockStatus",
@@ -2717,6 +2729,12 @@
         "responses": {}
       }
     },
+    "/v3/portal/configs/summaries": {
+      "get": {
+        "operationId": "listPortalConfigSummaries",
+        "responses": {}
+      }
+    },
     "/v3/portal/config/swap": {
       "post": {
         "operationId": "swapPortalConfig",

package/src/openapi.json

@@ -10025,6 +10025,86 @@
         }
       }
     },
+    "/v3/portal/public/user/temporary-password/complete": {
+      "post": {
+        "operationId": "completeTemporaryPassword",
+        "summary": "completeTemporaryPassword",
+        "description": "Replaces a portal user's temporary password with the password they chose.",
+        "tags": [
+          "Public"
+        ],
+        "security": [],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "org_id",
+                  "portal_id",
+                  "email",
+                  "temporary_password",
+                  "new_password"
+                ],
+                "properties": {
+                  "org_id": {
+                    "type": "string",
+                    "description": "Organization ID",
+                    "example": "123"
+                  },
+                  "portal_id": {
+                    "type": "string",
+                    "description": "ID of the portal the user belongs to",
+                    "example": "7hj28akg-97fb-4f5c-b2a1-3e4fbc1d8c7a"
+                  },
+                  "email": {
+                    "type": "string",
+                    "description": "Email address of the portal user",
+                    "example": "user@example.com"
+                  },
+                  "temporary_password": {
+                    "type": "string",
+                    "description": "Temporary password from the email"
+                  },
+                  "new_password": {
+                    "type": "string",
+                    "description": "New password, must match the portal's password policy"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The new password was set.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string",
+                      "example": "Password set successfully."
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/InvalidRequest"
+          },
+          "429": {
+            "$ref": "#/components/responses/TooManyRequests"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
     "/v2/portal/campaign/{campaign_id}/entity:status": {
       "put": {
         "operationId": "updateCampaignPortalBlockStatus",
@@ -11115,6 +11195,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",
@@ -11169,6 +11293,9 @@
                     "message": {
                       "type": "string",
                       "example": "Domain and users swapped successfully."
+                    },
+                    "portal_references": {
+                      "$ref": "#/components/schemas/SwapPortalReferencesResult"
                     }
                   }
                 }
@@ -13105,37 +13232,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",
@@ -14202,6 +14299,11 @@
             },
             "example": []
           },
+          "has_portal_user": {
+            "type": "boolean",
+            "description": "Whether the identified contact already has a portal user on this portal, so the caller\ncan skip offering account creation. Present only on a match; omitted when it could not\nbe determined.\n",
+            "example": false
+          },
           "reason": {
             "type": "string",
             "enum": [
@@ -15954,8 +16056,7 @@
                   "type": "string",
                   "enum": [
                     "portal-config",
-                    "portal-block",
-                    "portal-widget"
+                    "portal-block"
                   ]
                 },
                 "resource": {
@@ -20221,37 +20322,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",
@@ -20910,6 +20981,208 @@
           }
         ]
       },
+      "PortalFeatureSettings": {
+        "type": "object",
+        "description": "Feature settings for the portal",
+        "properties": {
+          "start_page": {
+            "type": "boolean",
+            "deprecated": true,
+            "description": "Retired, not read. A portal shows a start page by having a `dashboard` page."
+          },
+          "billing": {
+            "type": "boolean",
+            "deprecated": true,
+            "description": "Retired, not read. Billing follows the organization's `commodity_billing` setting."
+          },
+          "commodity_billing": {
+            "type": "boolean",
+            "deprecated": true,
+            "description": "Retired, not read. Billing pages and blocks follow the organization's `commodity_billing` setting."
+          },
+          "change_due_date": {
+            "type": "boolean",
+            "deprecated": true,
+            "description": "Retired, not read."
+          },
+          "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"
+          },
+          "portal_copilot": {
+            "type": "boolean",
+            "default": false,
+            "description": "Enable the portal copilot chat for this portal"
+          },
+          "portal_copilot_agent_id": {
+            "type": "string",
+            "description": "ID of the Agent Builder portal agent this portal's copilot chat runs, set by Agent Builder. When unset, or when the agent no longer exists in the portal's organization, the chat runs the default portal copilot."
+          }
+        }
+      },
+      "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"
+          },
+          "logo_image": {
+            "type": "object",
+            "description": "The logo to show for the portal in lists: the `logoImage` of the first page\nthat sets one. Absent when no page carries a logo; fall back to the design.\n",
+            "properties": {
+              "url": {
+                "type": "string",
+                "description": "Logo for the light theme",
+                "example": "https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/logo.png"
+              },
+              "dark_url": {
+                "type": "string",
+                "description": "Logo for the dark theme"
+              }
+            }
+          },
+          "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": {
@@ -20929,6 +21202,24 @@
             "type": "string",
             "description": "The URL to redirect to",
             "example": "https://example.com"
+          },
+          "title": {
+            "type": "string",
+            "description": "Portal name, served as the document title before the app boots",
+            "example": "Kundenportal"
+          },
+          "prevent_indexing": {
+            "type": "boolean",
+            "description": "Whether the served document should carry a `noindex, nofollow` robots meta tag"
+          },
+          "organization_id": {
+            "type": "string",
+            "description": "Organization of the portal, used to preload its design from the served document",
+            "example": "123"
+          },
+          "design_id": {
+            "type": "string",
+            "description": "Design of the portal, used to preload it from the served document"
           }
         }
       },
@@ -21207,9 +21498,82 @@
       },
       "SwappableConfig": {
         "type": "string",
-        "description": "Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum.",
+        "description": "Optional configuration item that a portal swap can additionally include. The swap always transfers the pages and the functional experience config that keep the portal working. These items are opt-in on top of that and are OFF by default. Domain and access/security settings (domain, cognito_details, auth_settings) can never be swapped and are therefore not part of this enum.\n- `email_templates`: swap the email templates of the two portals.\n- `portal_references`: after the swap, re-point configuration in other services from the source portal to the target portal: the portal on journey login (AuthControl) blocks and in file upload portal access, and the portal of automation flow portal triggers. One-directional: references to the target portal are left unchanged, because the target keeps its domain and users. System flows are not changed. Uses the caller's permissions; the outcome is returned in `portal_references`.",
         "enum": [
-          "email_templates"
+          "email_templates",
+          "portal_references"
+        ]
+      },
+      "SwapPortalReferencesResult": {
+        "type": "object",
+        "description": "Outcome of the `portal_references` swap option. Only present when that option was requested. The swap itself has already succeeded when this is returned, so failures here do not undo it.",
+        "properties": {
+          "journeys": {
+            "$ref": "#/components/schemas/SwapPortalReferenceGroup"
+          },
+          "automation_flows": {
+            "$ref": "#/components/schemas/SwapPortalReferenceGroup"
+          }
+        },
+        "required": [
+          "journeys",
+          "automation_flows"
+        ]
+      },
+      "SwapPortalReferenceGroup": {
+        "type": "object",
+        "properties": {
+          "updated": {
+            "type": "array",
+            "description": "Items whose references now point at the target portal.",
+            "items": {
+              "$ref": "#/components/schemas/SwapPortalReferenceItem"
+            }
+          },
+          "failed": {
+            "type": "array",
+            "description": "Items that reference the source portal but could not be updated.",
+            "items": {
+              "$ref": "#/components/schemas/SwapPortalReferenceItem"
+            }
+          },
+          "list_error": {
+            "type": "string",
+            "description": "Set when the items could not be listed, so none of them were checked."
+          }
+        },
+        "required": [
+          "updated",
+          "failed"
+        ]
+      },
+      "SwapPortalReferenceItem": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Journey id or automation flow id."
+          },
+          "name": {
+            "type": "string"
+          },
+          "paths": {
+            "type": "array",
+            "description": "Where the reference sat in the item.",
+            "items": {
+              "type": "string"
+            },
+            "example": [
+              "steps[0].uischema.elements[2].options.portalId"
+            ]
+          },
+          "error": {
+            "type": "string",
+            "description": "Why the update failed. Only set on failed items."
+          }
+        },
+        "required": [
+          "id"
         ]
       },
       "PortalUserRegistrationStatus": {