@epilot/entity-client 7.3.0 → 7.3.2

package/dist/openapi.d.ts

@@ -834,6 +834,19 @@ declare namespace Components {
              */
             DefaultAddressFields;
         }
+        /**
+         * Configuration for adjusting a contract installment through a Journey.
+         * example:
+         * {
+         *   "journey_id": "adjust-installment-flow"
+         * }
+         */
+        export interface AdjustInstallmentCapabilityConfig {
+            /**
+             * ID of the Flow Journey to open when adjusting the installment.
+             */
+            journey_id: string;
+        }
         export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Dynamic data table with configurable columns. Data is stored as an array of objects where each object represents a row. */ TableAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute;
         /**
          * a readonly computed ID for the attribute including schema slug and the attribute ID
@@ -3297,6 +3310,15 @@ declare namespace Components {
              */
             title?: string;
             attributes?: Attribute[];
+            /**
+             * Allow conditional variants of the entity to override the values managed by this
+             * capability. Only meaningful on schemas that declare `conditions` and on capabilities
+             * that render an attribute group (`EntityAttributes:Group` ui hook), e.g. pricing tiers.
+             * Attributes carried by the capability opt in individually via their own
+             * `variant_overridable` flag.
+             *
+             */
+            variant_overridable?: boolean;
             _purpose?: /**
              * example:
              * taxonomy-slug:classification-slug
@@ -3312,6 +3334,14 @@ declare namespace Components {
              * 123e4567-e89b-12d3-a456-426614174000
              */
             app_id?: string;
+            adjust_installment?: /**
+             * Configuration for adjusting a contract installment through a Journey.
+             * example:
+             * {
+             *   "journey_id": "adjust-installment-flow"
+             * }
+             */
+            AdjustInstallmentCapabilityConfig;
             ui_config?: {
                 /**
                  * Whether the capability is filterable
@@ -3395,6 +3425,18 @@ declare namespace Components {
                      */
                     resource?: string;
                 };
+                /**
+                 * Whether this widget is switched on by default for entity types that have the capability. Only meaningful on the `EntityDetailsV2:Widget` hook. Defaults to true when omitted. An admin's explicit choice in the entity builder is stored in the schema's `ui_config.widget_visibility` and wins over this.
+                 * example:
+                 * false
+                 */
+                default_visible?: boolean;
+                /**
+                 * The pricing-tier settings key an organisation must have enabled to use this widget. Omit for widgets available to everyone. Resolved against `GET /v2/pricing-tiers/me` as `override_settings[key].enabled ?? settings[key].enabled`. Note this is commercial packaging enforced in the UI, not a security control — the key must also be added to the pricing tier settings list in epilot-admin-portal, or it can never be switched on for a tier.
+                 * example:
+                 * entity_address_maps
+                 */
+                pricing_tier_setting?: string;
             }[];
             /**
              * This capability should only be active when the feature flag is enabled
@@ -3442,6 +3484,15 @@ declare namespace Components {
              */
             title?: string;
             attributes?: Attribute[];
+            /**
+             * Allow conditional variants of the entity to override the values managed by this
+             * capability. Only meaningful on schemas that declare `conditions` and on capabilities
+             * that render an attribute group (`EntityAttributes:Group` ui hook), e.g. pricing tiers.
+             * Attributes carried by the capability opt in individually via their own
+             * `variant_overridable` flag.
+             *
+             */
+            variant_overridable?: boolean;
             _purpose?: /**
              * example:
              * taxonomy-slug:classification-slug
@@ -3457,6 +3508,14 @@ declare namespace Components {
              * 123e4567-e89b-12d3-a456-426614174000
              */
             app_id?: string;
+            adjust_installment?: /**
+             * Configuration for adjusting a contract installment through a Journey.
+             * example:
+             * {
+             *   "journey_id": "adjust-installment-flow"
+             * }
+             */
+            AdjustInstallmentCapabilityConfig;
             ui_config?: {
                 /**
                  * Whether the capability is filterable
@@ -3540,6 +3599,18 @@ declare namespace Components {
                      */
                     resource?: string;
                 };
+                /**
+                 * Whether this widget is switched on by default for entity types that have the capability. Only meaningful on the `EntityDetailsV2:Widget` hook. Defaults to true when omitted. An admin's explicit choice in the entity builder is stored in the schema's `ui_config.widget_visibility` and wins over this.
+                 * example:
+                 * false
+                 */
+                default_visible?: boolean;
+                /**
+                 * The pricing-tier settings key an organisation must have enabled to use this widget. Omit for widgets available to everyone. Resolved against `GET /v2/pricing-tiers/me` as `override_settings[key].enabled ?? settings[key].enabled`. Note this is commercial packaging enforced in the UI, not a security control — the key must also be added to the pricing tier settings list in epilot-admin-portal, or it can never be switched on for a tier.
+                 * example:
+                 * entity_address_maps
+                 */
+                pricing_tier_setting?: string;
             }[];
             /**
              * This capability should only be active when the feature flag is enabled
@@ -4555,6 +4626,17 @@ declare namespace Components {
                  * Ordered list of widget ids controlling the entity-details widget-grid order. Each id is a capability widget's `component` (or `summary` for the synthesized summary card); widgets absent from the list keep their natural order at the end.
                  */
                 widget_order?: string[];
+                /**
+                 * Per-widget on/off state for the entity-details widget grid, keyed by widget id (a capability widget's `component`, or `summary` for the synthesized summary card). Holds only the admin's deviations from each widget's declared default: a widget absent from this map falls back to its ui_hook `default_visible`, and then to visible. Do not seed this map from migrations — doing so would freeze today's defaults into the schema.
+                 * example:
+                 * {
+                 *   "next_best_action": true,
+                 *   "address_map": false
+                 * }
+                 */
+                widget_visibility?: {
+                    [name: string]: boolean;
+                };
             };
             capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
             /**
@@ -4986,6 +5068,17 @@ declare namespace Components {
                  * Ordered list of widget ids controlling the entity-details widget-grid order. Each id is a capability widget's `component` (or `summary` for the synthesized summary card); widgets absent from the list keep their natural order at the end.
                  */
                 widget_order?: string[];
+                /**
+                 * Per-widget on/off state for the entity-details widget grid, keyed by widget id (a capability widget's `component`, or `summary` for the synthesized summary card). Holds only the admin's deviations from each widget's declared default: a widget absent from this map falls back to its ui_hook `default_visible`, and then to visible. Do not seed this map from migrations — doing so would freeze today's defaults into the schema.
+                 * example:
+                 * {
+                 *   "next_best_action": true,
+                 *   "address_map": false
+                 * }
+                 */
+                widget_visibility?: {
+                    [name: string]: boolean;
+                };
             };
             capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
             /**
@@ -19436,6 +19529,7 @@ export type ActivityItem = Components.Schemas.ActivityItem;
 export type ActivityType = Components.Schemas.ActivityType;
 export type AddressAttribute = Components.Schemas.AddressAttribute;
 export type AddressRelationAttribute = Components.Schemas.AddressRelationAttribute;
+export type AdjustInstallmentCapabilityConfig = Components.Schemas.AdjustInstallmentCapabilityConfig;
 export type Attribute = Components.Schemas.Attribute;
 export type AttributeWithCompositeID = Components.Schemas.AttributeWithCompositeID;
 export type AutomationAttribute = Components.Schemas.AutomationAttribute;

package/dist/openapi.json

@@ -5097,6 +5097,17 @@
                 "items": {
                   "type": "string"
                 }
+              },
+              "widget_visibility": {
+                "type": "object",
+                "description": "Per-widget on/off state for the entity-details widget grid, keyed by widget id (a capability widget's `component`, or `summary` for the synthesized summary card). Holds only the admin's deviations from each widget's declared default: a widget absent from this map falls back to its ui_hook `default_visible`, and then to visible. Do not seed this map from migrations — doing so would freeze today's defaults into the schema.",
+                "additionalProperties": {
+                  "type": "boolean"
+                },
+                "example": {
+                  "next_best_action": true,
+                  "address_map": false
+                }
               }
             }
           },
@@ -7405,6 +7416,24 @@
         "pattern": "^[a-zA-Z0-9_-]+$",
         "example": "contact"
       },
+      "AdjustInstallmentCapabilityConfig": {
+        "description": "Configuration for adjusting a contract installment through a Journey.",
+        "type": "object",
+        "additionalProperties": false,
+        "example": {
+          "journey_id": "adjust-installment-flow"
+        },
+        "required": [
+          "journey_id"
+        ],
+        "properties": {
+          "journey_id": {
+            "type": "string",
+            "minLength": 1,
+            "description": "ID of the Flow Journey to open when adjusting the installment."
+          }
+        }
+      },
       "EntityCapability": {
         "description": "Capabilities the Entity has. Turn features on/off for entities.",
         "type": "object",
@@ -7430,6 +7459,11 @@
               "$ref": "#/components/schemas/Attribute"
             }
           },
+          "variant_overridable": {
+            "type": "boolean",
+            "default": false,
+            "description": "Allow conditional variants of the entity to override the values managed by this\ncapability. Only meaningful on schemas that declare `conditions` and on capabilities\nthat render an attribute group (`EntityAttributes:Group` ui hook), e.g. pricing tiers.\nAttributes carried by the capability opt in individually via their own\n`variant_overridable` flag.\n"
+          },
           "_purpose": {
             "type": "array",
             "items": {
@@ -7451,6 +7485,9 @@
             "description": "ID of the app if the capability is provided by an app",
             "example": "123e4567-e89b-12d3-a456-426614174000"
           },
+          "adjust_installment": {
+            "$ref": "#/components/schemas/AdjustInstallmentCapabilityConfig"
+          },
           "ui_config": {
             "type": "object",
             "properties": {
@@ -7534,6 +7571,16 @@
                   "required": [
                     "action"
                   ]
+                },
+                "default_visible": {
+                  "type": "boolean",
+                  "description": "Whether this widget is switched on by default for entity types that have the capability. Only meaningful on the `EntityDetailsV2:Widget` hook. Defaults to true when omitted. An admin's explicit choice in the entity builder is stored in the schema's `ui_config.widget_visibility` and wins over this.",
+                  "example": false
+                },
+                "pricing_tier_setting": {
+                  "type": "string",
+                  "description": "The pricing-tier settings key an organisation must have enabled to use this widget. Omit for widgets available to everyone. Resolved against `GET /v2/pricing-tiers/me` as `override_settings[key].enabled ?? settings[key].enabled`. Note this is commercial packaging enforced in the UI, not a security control — the key must also be added to the pricing tier settings list in epilot-admin-portal, or it can never be switched on for a tier.",
+                  "example": "entity_address_maps"
                 }
               },
               "required": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/entity-client",
-  "version": "7.3.0",
+  "version": "7.3.2",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",