@epilot/sdk 2.3.6 → 2.3.7-rc1

package/docs/customer-portal.md

@@ -72,16 +72,18 @@ const { data } = await customerPortalClient.upsertPortal(...)
 - [`deletePortalConfig`](#deleteportalconfig)
 - [`listAllPortalConfigs`](#listallportalconfigs)
 - [`swapPortalConfig`](#swapportalconfig)
+- [`clonePortalConfig`](#cloneportalconfig)
 
 **Public**
-- [`createUser`](#createuser)
 - [`createUserV3`](#createuserv3)
 - [`getPortalConfigByDomain`](#getportalconfigbydomain)
 - [`getPublicPortalExtensionDetails`](#getpublicportalextensiondetails)
 - [`getPublicPortalExtensionDetailsV3`](#getpublicportalextensiondetailsv3)
 - [`getPublicPortalConfig`](#getpublicportalconfig)
 - [`getPublicPortalConfigV3`](#getpublicportalconfigv3)
+- [`getPublicPortalWidgetsV3`](#getpublicportalwidgetsv3)
 - [`getSchemasByDomain`](#getschemasbydomain)
+- [`getPublicSchemasV3`](#getpublicschemasv3)
 - [`getOrganizationSettingsByDomain`](#getorganizationsettingsbydomain)
 - [`checkContactExists`](#checkcontactexists)
 - [`checkContactExistsV3`](#checkcontactexistsv3)
@@ -128,6 +130,7 @@ const { data } = await customerPortalClient.upsertPortal(...)
 - [`uploadMeterReadingPhoto`](#uploadmeterreadingphoto)
 - [`createMeterReading`](#createmeterreading)
 - [`getAllowedMeterReadingRange`](#getallowedmeterreadingrange)
+- [`getMeterReadings`](#getmeterreadings)
 - [`getPortalPage`](#getportalpage)
 - [`getPortalPages`](#getportalpages)
 - [`getPortalPageBlocks`](#getportalpageblocks)
@@ -670,51 +673,6 @@ const { data } = await client.upsertPortal(
 
 ---
 
-### `createUser`
-
-Registers a portal user
-
-`POST /v2/portal/public/user`
-
-```ts
-const { data } = await client.createUser(
-  {
-    origin: 'example',
-  },
-  {
-    email: 'testemail921@yopmail.com',
-    first_name: 'John',
-    last_name: 'Doe',
-    contactId: '5da0a718-c822-403d-9f5d-20d4584e0528',
-    orgId: 728,
-    password: '124n$aAJs*d41h4',
-    contactIdentifiers: {},
-    registration_identifiers: {
-      contact: {
-        email: 'john.doe@example.com'
-      },
-      contract: {
-        contract_number: '123456'
-      }
-    },
-    account_id: 'string'
-  },
-)
-```
-
-<details>
-<summary>Response</summary>
-
-```json
-{
-  "message": "User created successfully"
-}
-```
-
-</details>
-
----
-
 ### `createUserV3`
 
 Registers a portal user.
@@ -1660,7 +1618,8 @@ const { data } = await client.getConsumption({
     {
       "timestamp": "1970-01-01T00:00:00.000Z",
       "value": 0,
-      "type": "string"
+      "type": "nt",
+      "aggregation_method": "sum"
     }
   ]
 }
@@ -2946,6 +2905,65 @@ const { data } = await client.getEmailTemplatesByPortalId({
 
 ---
 
+### `getPublicPortalWidgetsV3`
+
+Retrieves the public widgets of a portal.
+Supports two identification methods:
+1. Using org_id + portal_id
+2. Using domain
+
+`GET /v3/portal/public/widgets`
+
+```ts
+const { data } = await client.getPublicPortalWidgetsV3({
+  org_id: 'example',
+  portal_id: 'example',
+  domain: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "widgets": [
+    {
+      "id": "string",
+      "type": "ACTION_WIDGET",
+      "listIndex": 0,
+      "headline": {
+        "en": "string",
+        "de": "string"
+      },
+      "subHeadline": {
+        "en": "string",
+        "de": "string"
+      },
+      "schema": "string"
+    },
+    {
+      "id": "string",
+      "type": "ACTION_WIDGET",
+      "listIndex": 0,
+      "headline": {
+        "en": "string",
+        "de": "string"
+      },
+      "subHeadline": {
+        "en": "string",
+        "de": "string"
+      },
+      "content": "string"
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
 ### `getPortalWidgetsV3`
 
 Retrieves the widgets of a portal by portal_id.
@@ -3131,6 +3149,13 @@ const { data } = await client.savePortalFilesV3(
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "_schema": "file"
     }
   ]
@@ -3243,6 +3268,40 @@ const { data } = await client.getSchemasByDomain({
 
 ---
 
+### `getPublicSchemasV3`
+
+Retrieves schemas by portal. Only schemas and attributes used on public pages are returned.
+Supports two identification methods:
+1. Using org_id + portal_id
+2. Using domain
+
+`GET /v3/portal/public/schemas`
+
+```ts
+const { data } = await client.getPublicSchemasV3({
+  org_id: 'example',
+  portal_id: 'example',
+  domain: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "schemas": [
+    {
+      "slug": "contact"
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
 ### `getOrganizationSettingsByDomain`
 
 Retrieves organization settings by domain. Only public organization settings are returned.
@@ -3468,6 +3527,13 @@ const { data } = await client.getContact()
     "_tags": ["example", "mock"],
     "_created_at": "2021-02-09T12:41:43.662Z",
     "_updated_at": "2021-02-09T12:41:43.662Z",
+    "templates_output_highlighted": {},
+    "search_snippets": [
+      {
+        "field": "string",
+        "fragment": "string"
+      }
+    ],
     "_schema": "contact"
   },
   "files": [
@@ -3478,6 +3544,13 @@ const { data } = await client.getContact()
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "_schema": "file"
     }
   ],
@@ -3489,6 +3562,13 @@ const { data } = await client.getContact()
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "templates_output": {
         "content_top_name": "Customer #123456",
         "main_content_name": "Orange Flexible A2 (654321)",
@@ -3549,6 +3629,13 @@ const { data } = await client.getECPContact({
     "_tags": ["example", "mock"],
     "_created_at": "2021-02-09T12:41:43.662Z",
     "_updated_at": "2021-02-09T12:41:43.662Z",
+    "templates_output_highlighted": {},
+    "search_snippets": [
+      {
+        "field": "string",
+        "fragment": "string"
+      }
+    ],
     "_schema": "contact"
   }
 }
@@ -3690,6 +3777,13 @@ const { data } = await client.getPortalUser()
     "_tags": ["example", "mock"],
     "_created_at": "2021-02-09T12:41:43.662Z",
     "_updated_at": "2021-02-09T12:41:43.662Z",
+    "templates_output_highlighted": {},
+    "search_snippets": [
+      {
+        "field": "string",
+        "fragment": "string"
+      }
+    ],
     "_schema": "portal_user"
   }
 }
@@ -3708,7 +3802,15 @@ Update the portal user details
 ```ts
 const { data } = await client.updatePortalUser(
   null,
-  {},
+  {
+    templates_output_highlighted: {},
+    search_snippets: [
+      {
+        field: 'string',
+        fragment: 'string'
+      }
+    ]
+  },
 )
 ```
 
@@ -3724,6 +3826,13 @@ const { data } = await client.updatePortalUser(
     "_tags": ["example", "mock"],
     "_created_at": "2021-02-09T12:41:43.662Z",
     "_updated_at": "2021-02-09T12:41:43.662Z",
+    "templates_output_highlighted": {},
+    "search_snippets": [
+      {
+        "field": "string",
+        "fragment": "string"
+      }
+    ],
     "_schema": "portal_user"
   }
 }
@@ -3837,6 +3946,13 @@ const { data } = await client.fetchPortalUsersByRelatedEntity({
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "_schema": "portal_user"
     }
   ]
@@ -4063,6 +4179,13 @@ const { data } = await client.postOrderAcceptance(
     "_tags": ["example", "mock"],
     "_created_at": "2021-02-09T12:41:43.662Z",
     "_updated_at": "2021-02-09T12:41:43.662Z",
+    "templates_output_highlighted": {},
+    "search_snippets": [
+      {
+        "field": "string",
+        "fragment": "string"
+      }
+    ],
     "_schema": "order"
   }
 }
@@ -4105,6 +4228,13 @@ const { data } = await client.addContractByIdentifiers(
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "templates_output": {
         "content_top_name": "Customer #123456",
         "main_content_name": "Orange Flexible A2 (654321)",
@@ -4266,6 +4396,13 @@ const { data } = await client.searchPaymentRelationsInEntities({
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "templates_output": {
         "content_top_name": "Customer #123456",
         "main_content_name": "Orange Flexible A2 (654321)",
@@ -4365,6 +4502,13 @@ const { data } = await client.saveEntityFile(
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "_schema": "file"
     }
   ]
@@ -4433,6 +4577,13 @@ const { data } = await client.savePortalFiles(
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "_schema": "file"
     }
   ]
@@ -4505,6 +4656,13 @@ const { data } = await client.trackFileDownloaded({
     "_tags": ["example", "mock"],
     "_created_at": "2021-02-09T12:41:43.662Z",
     "_updated_at": "2021-02-09T12:41:43.662Z",
+    "templates_output_highlighted": {},
+    "search_snippets": [
+      {
+        "field": "string",
+        "fragment": "string"
+      }
+    ],
     "_schema": "file",
     "filename": "document.pdf",
     "access_control": "private",
@@ -4571,6 +4729,13 @@ const { data } = await client.getBillingEvents({
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "type": "installment",
       "due_date": "1970-01-01",
       "paid_date": "1970-01-01"
@@ -4652,7 +4817,14 @@ const { data } = await client.getBillingAccount({
     "_org": "123",
     "_tags": ["example", "mock"],
     "_created_at": "2021-02-09T12:41:43.662Z",
-    "_updated_at": "2021-02-09T12:41:43.662Z"
+    "_updated_at": "2021-02-09T12:41:43.662Z",
+    "templates_output_highlighted": {},
+    "search_snippets": [
+      {
+        "field": "string",
+        "fragment": "string"
+      }
+    ]
   },
   "relations": [
     {
@@ -4662,6 +4834,13 @@ const { data } = await client.getBillingAccount({
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "templates_output": {
         "content_top_name": "Customer #123456",
         "main_content_name": "Orange Flexible A2 (654321)",
@@ -4833,6 +5012,13 @@ const { data } = await client.getPortalUserEntity(
     "_tags": ["example", "mock"],
     "_created_at": "2021-02-09T12:41:43.662Z",
     "_updated_at": "2021-02-09T12:41:43.662Z",
+    "templates_output_highlighted": {},
+    "search_snippets": [
+      {
+        "field": "string",
+        "fragment": "string"
+      }
+    ],
     "templates_output": {
       "content_top_name": "Customer #123456",
       "main_content_name": "Orange Flexible A2 (654321)",
@@ -4903,7 +5089,8 @@ const { data } = await client.searchPortalUserEntities(
       /* ... 1 more */
     ],
     targets: ['3ec28ab5-8598-41ef-9486-b57fca1d5e2a'],
-    include: ['active_workflow']
+    include: ['active_workflow'],
+    highlight: {}
   },
 )
 ```
@@ -4921,6 +5108,13 @@ const { data } = await client.searchPortalUserEntities(
       "_tags": ["example", "mock"],
       "_created_at": "2021-02-09T12:41:43.662Z",
       "_updated_at": "2021-02-09T12:41:43.662Z",
+      "templates_output_highlighted": {},
+      "search_snippets": [
+        {
+          "field": "string",
+          "fragment": "string"
+        }
+      ],
       "templates_output": {
         "content_top_name": "Customer #123456",
         "main_content_name": "Orange Flexible A2 (654321)",
@@ -5249,6 +5443,46 @@ const { data } = await client.getAllowedMeterReadingRange({
 
 ---
 
+### `getMeterReadings`
+
+Get meter readings with optional template resolution
+
+`POST /v2/portal/metering/readings`
+
+```ts
+const { data } = await client.getMeterReadings(
+  null,
+  {
+    meter_id: 'string',
+    counter_id: 'string',
+    sort: 'desc',
+    from: 0,
+    size: 10,
+    templates: {},
+    counter_templates: {}
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "results": [
+    {
+      "templates_output": {}
+    }
+  ],
+  "hits": 0,
+  "counter_templates_output": {}
+}
+```
+
+</details>
+
+---
+
 ### `ssoLogin`
 
 Initiate login using external SSO identity.
@@ -7488,6 +7722,249 @@ const { data } = await client.swapPortalConfig(
 
 ---
 
+### `clonePortalConfig`
+
+Creates a new portal by cloning configuration and pages from an existing portal. The new portal gets its own domain, users, email templates, and authentication settings.
+
+`POST /v3/portal/config/clone`
+
+```ts
+const { data } = await client.clonePortalConfig(
+  null,
+  {
+    source_portal_id: '453ad7bf-86d5-46c8-8252-bcc868df5e3c',
+    name: 'string'
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "entity_actions": [
+    {
+      "journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
+      "slug": "contact",
+      "action_Label": {}
+    }
+  ],
+  "extensions": [
+    {
+      "id": "string",
+      "status": "installed",
+      "options": {}
+    }
+  ],
+  "extension_hooks": {},
+  "default_user_to_notify": {
+    "onPendingUser": [
+      {}
+    ]
+  },
+  "enabled": true,
+  "name": "Installer Portal",
+  "domain": "abc.com",
+  "is_epilot_domain": true,
+  "design_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
+  "allowed_portal_entities": ["contact", "contract"],
+  "self_registration_setting": "ALLOW_WITH_CONTACT_CREATION",
+  "user_account_self_management": false,
+  "feature_settings": {
+    "start_page": true,
+    "billing": true,
+    "change_due_date": true,
+    "new_design": true
+  },
+  "accessToken": "string",
+  "advanced_mfa": {
+    "enabled": true
+  },
+  "auth_settings": {
+    "passwordless_login": {
+      "enabled": true
+    },
+    "entry_point": "PASSWORD",
+    "preferred_sso_providers": ["office-365-login"],
+    "auto_redirect_to_sso": true
+  },
+  "cognito_details": {
+    "cognito_user_pool_client_id": "6bsd0jkgoie74k2i8mrhc1vest",
+    "cognito_user_pool_arn": "arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341",
+    "cognito_user_pool_id": "eu-central-1_CUEQRNbUb",
+    "timeouts": {
+      "refresh_token": 300,
+      "access_token": 300,
+      "id_token": 300
+    },
+    "advanced_authentication": {
+      "user_activity_logging": true,
+      "adaptive_authentication": true,
+      "compromised_credentials_detection": true
+    },
+    "password_policy": {
+      "minimum_length": 8,
+      "maximum_length": 256,
+      "require_lowercase": true,
+      "require_uppercase": true,
+      "require_numbers": true,
+      "require_symbols": true
+    }
+  },
+  "config": "string",
+  "contact_identifiers": ["email", "last_name"],
+  "approval_state_attributes": {
+    "contact": ["name", "address"],
+    "contract": ["installment_amount"]
+  },
+  "email_templates": {
+    "confirmAccount": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "advancedAuth": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "advancedMFA": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "journeySignUp": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "journeySignInOneTimePassword": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "journeyLoginOTP": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "forgotPassword": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "invitation": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "partnerInvitation": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "onNewQuote": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "onMapAPendingUser": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "onDocUpload": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "onWorkflowStepAssigned": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "confirmEmailUpdate": "5da0a718-c822-403d-9f5d-20d4584e0528",
+    "verifyCodeToSetPassword": "5da0a718-c822-403d-9f5d-20d4584e0528"
+  },
+  "images": {
+    "orderLeftTeaser": "https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-left-teaser.jpeg",
+    "orderRightTeaser": "https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/order-right-teaser.jpeg",
+    "welcomeBanner": "https://epilot-bucket.s3.eu-central-1.amazonaws.com/12344/6538fddb-f0e9-4f0f-af51-6e57891ff20a/welcome-banner.jpeg"
+  },
+  "entity_identifiers": {
+    "type": {
+      "isEnabled": true,
+      "attributes": ["contract_number"]
+    }
+  },
+  "contract_identifiers": [
+    {
+      "name": "email",
+      "schema": "contact"
+    },
+    {
+      "name": "last_name",
+      "schema": "contact"
+    }
+  ],
+  "contract_selector_config": {
+    "show_inactive": true,
+    "title_path": "string"
+  },
+  "registration_identifiers": [
+    {
+      "name": "last_name",
+      "schema": "contact"
+    },
+    {
+      "name": "contract_number",
+      "schema": "contract"
+    }
+  ],
+  "triggered_journeys": [
+    {
+      "trigger_name": "FIRST_LOGIN",
+      "journey_id": "5da0a718-c822-403d-9f5d-20d4584e0528"
+    }
+  ],
+  "entity_edit_rules": [
+    {
+      "slug": "contact",
+      "attribute": "first_name",
+      "rule_type": "cadence",
+      "cadence_period_type": "days",
+      "cadence_period": 1,
+      "changes_allowed": 1,
+      "grace_period": 1,
+      "allowed_increment": "10%",
+      "allowed_decrement": "10%",
+      "number_of_days_before_restriction": 10
+    }
+  ],
+  "allowed_file_extensions": {
+    "document": ["pdf"],
+    "image": ["jpg"],
+    "spreadsheet": ["xls"],
+    "presentation": ["ppt"],
+    "audioVideo": ["mp4"],
+    "email": ["eml"],
+    "archive": ["zip"],
+    "cad": ["cad"],
+    "calendar": ["ics"],
+    "other": ["txt"]
+  },
+  "prevent_search_engine_indexing": true,
+  "meter_reading_grace_period": 0,
+  "inactive_contract_cutoff_years": 0,
+  "is_dummy": true,
+  "is_v3_item": true,
+  "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c",
+  "portal_sk_v3": "PORTAL_CONFIG#453ad7bf-86d5-46c8-8252-bcc868df5e3c",
+  "origin": "string",
+  "organization_id": 12345,
+  "org_settings": {
+    "canary": {
+      "enabled": true
+    },
+    "notracking": {
+      "enabled": true
+    }
+  },
+  "feature_flags": {},
+  "grants": [
+    {
+      "action": "entity-read",
+      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",
+      "effect": "allow"
+    }
+  ],
+  "identity_providers": [
+    {
+      "slug": "office-365-login",
+      "display_name": "Office 365 Login",
+      "oidc_config": {},
+      "mobile_oidc_config": {}
+    }
+  ],
+  "pages": [
+    {
+      "slug": "dashboard",
+      "path": "/dashboard",
+      "schema": ["string"],
+      "visibility": {},
+      "content": {},
+      "design": {},
+      "blocks": {},
+      "order": 1,
+      "is_system": false,
+      "is_detail": false,
+      "detail_schema": "contact",
+      "show_in_navigation": false,
+      "is_public": true,
+      "parentId": "c495fef9-eeca-4019-a989-8390dcd9825b",
+      "is_entry_route": false,
+      "is_deleted": false,
+      "id": "c495fef9-eeca-4019-a989-8390dcd9825b",
+      "last_modified_at": "2021-02-09T12:41:43.662Z",
+      "portal_id": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
 ### `invitePartner`
 
 Invites a partner to a portal
@@ -8774,7 +9251,13 @@ type Schema = {
 ### `Entity`
 
 ```ts
-type Entity = Record<string, unknown>
+type Entity = {
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
+}
 ```
 
 ### `EntityTemplates`
@@ -8795,6 +9278,11 @@ type EntityItem = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
   templates_output?: Record<string, string | Record<string, string>>
   _schema: string
 }
@@ -8813,6 +9301,11 @@ type EntityResponse = {
     _tags?: string[]
     _created_at: string // date-time
     _updated_at: string // date-time
+    templates_output_highlighted?: Record<string, string | Record<string, string>>
+    search_snippets?: Array<{
+      field?: { ... }
+      fragment?: { ... }
+    }>
     templates_output?: Record<string, string | Record<string, string>>
     _schema: string
   }
@@ -8832,6 +9325,11 @@ type EntityResponseWithHits = {
     _tags?: string[]
     _created_at: string // date-time
     _updated_at: string // date-time
+    templates_output_highlighted?: Record<string, string | Record<string, string>>
+    search_snippets?: Array<{
+      field?: { ... }
+      fragment?: { ... }
+    }>
     templates_output?: Record<string, string | Record<string, string>>
     _schema: string
   }>
@@ -8865,6 +9363,8 @@ type EntityResponseGroupedWithHits = {
       _tags?: { ... }
       _created_at: { ... }
       _updated_at: { ... }
+      templates_output_highlighted?: { ... }
+      search_snippets?: { ... }
       templates_output?: { ... }
       _schema: { ... }
     }>
@@ -8908,6 +9408,11 @@ type PortalUser = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
   _schema: "portal_user"
 }
 ```
@@ -8924,6 +9429,11 @@ type Contact = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
   _schema: "contact"
 }
 ```
@@ -8951,6 +9461,11 @@ type Meter = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
   _schema: "meter"
 }
 ```
@@ -8967,6 +9482,11 @@ type Order = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
   _schema: "order"
 }
 ```
@@ -8983,6 +9503,11 @@ type Opportunity = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
   _schema: "opportunity"
 }
 ```
@@ -8999,6 +9524,11 @@ type Contract = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
   contract_name?: string
   contract_number?: string
   status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired"
@@ -9036,6 +9566,11 @@ type File = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
   _schema: "file"
 }
 ```
@@ -9052,6 +9587,11 @@ type Product = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
   _schema: "product"
 }
 ```
@@ -9270,6 +9810,11 @@ type BaseBillingEvent = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
 }
 ```
 
@@ -9361,6 +9906,11 @@ type BillingAccount = {
   _tags?: string[]
   _created_at: string // date-time
   _updated_at: string // date-time
+  templates_output_highlighted?: Record<string, string | Record<string, string>>
+  search_snippets?: Array<{
+    field?: string
+    fragment?: string
+  }>
 }
 ```
 
@@ -9423,6 +9973,7 @@ type EntitySearchParams = {
   filters_context?: Record<string, boolean | string>[]
   targets?: string // uuid[]
   include?: "active_workflow"[]
+  highlight?: object
 }
 ```