Feature/pricing adjust instalment journey

clients/entity-client/package.json

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

clients/entity-client/src/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
@@ -3312,6 +3325,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
@@ -3457,6 +3478,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
@@ -15420,7 +15449,7 @@ declare namespace Paths {
             /**
              * ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
              * example:
-             * 2023-01-01T00:00:00.000Z
+             * 2023-01-01T00:00:00Z
              */
             export type CreatedAfter = string; // date-time
             /**
@@ -15446,7 +15475,7 @@ declare namespace Paths {
             created_after?: /**
              * ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
              * example:
-             * 2023-01-01T00:00:00.000Z
+             * 2023-01-01T00:00:00Z
              */
             Parameters.CreatedAfter /* date-time */;
             sort_pending_first?: /* When true, sorts PENDING status jobs to the top of the results. */ Parameters.SortPendingFirst;
@@ -19436,6 +19465,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;

clients/entity-client/src/openapi.json

@@ -3947,7 +3947,7 @@
               "description": "ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).",
               "type": "string",
               "format": "date-time",
-              "example": "2023-01-01T00:00:00.000Z"
+              "example": "2023-01-01T00:00:00Z"
             }
           },
           {
@@ -7405,6 +7405,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",
@@ -7451,6 +7469,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": {

packages/epilot-sdk-v2/docs/entity.md

@@ -190,6 +190,7 @@ const { data } = await entityClient.listSchemas(...)
 - [`LocationConditionDefinition`](#locationconditiondefinition)
 - [`ConditionDefinition`](#conditiondefinition)
 - [`EntitySlug`](#entityslug)
+- [`AdjustInstallmentCapabilityConfig`](#adjustinstallmentcapabilityconfig)
 - [`EntityCapability`](#entitycapability)
 - [`EntityCapabilityWithCompositeID`](#entitycapabilitywithcompositeid)
 - [`EntityViewDisabled`](#entityviewdisabled)
@@ -497,6 +498,9 @@ const { data } = await client.getSchema({
       "_purpose": ["taxonomy-slug:classification-slug"],
       "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "app_id": "123e4567-e89b-12d3-a456-426614174000",
+      "adjust_installment": {
+        "journey_id": "adjust-installment-flow"
+      },
       "ui_config": {},
       "ui_hooks": [],
       "feature_flag": "FF_MY_FEATURE_FLAG",
@@ -649,6 +653,9 @@ const { data } = await client.putSchema(
         _purpose: ['taxonomy-slug:classification-slug'],
         _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
         app_id: '123e4567-e89b-12d3-a456-426614174000',
+        adjust_installment: {
+          journey_id: 'adjust-installment-flow'
+        },
         ui_config: { /* ... */ },
         ui_hooks: [ /* ... */ ],
         feature_flag: 'FF_MY_FEATURE_FLAG',
@@ -801,6 +808,9 @@ const { data } = await client.putSchema(
       "_purpose": ["taxonomy-slug:classification-slug"],
       "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "app_id": "123e4567-e89b-12d3-a456-426614174000",
+      "adjust_installment": {
+        "journey_id": "adjust-installment-flow"
+      },
       "ui_config": {},
       "ui_hooks": [],
       "feature_flag": "FF_MY_FEATURE_FLAG",
@@ -1245,6 +1255,9 @@ const { data } = await client.freezeSchema(
       "_purpose": ["taxonomy-slug:classification-slug"],
       "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "app_id": "123e4567-e89b-12d3-a456-426614174000",
+      "adjust_installment": {
+        "journey_id": "adjust-installment-flow"
+      },
       "ui_config": {},
       "ui_hooks": [],
       "feature_flag": "FF_MY_FEATURE_FLAG",
@@ -1411,6 +1424,9 @@ const { data } = await client.unfreezeSchema({
       "_purpose": ["taxonomy-slug:classification-slug"],
       "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "app_id": "123e4567-e89b-12d3-a456-426614174000",
+      "adjust_installment": {
+        "journey_id": "adjust-installment-flow"
+      },
       "ui_config": {},
       "ui_hooks": [],
       "feature_flag": "FF_MY_FEATURE_FLAG",
@@ -1515,6 +1531,9 @@ const { data } = await client.listAvailableCapabilities({
       "_purpose": ["taxonomy-slug:classification-slug"],
       "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
       "app_id": "123e4567-e89b-12d3-a456-426614174000",
+      "adjust_installment": {
+        "journey_id": "adjust-installment-flow"
+      },
       "ui_config": {},
       "ui_hooks": [],
       "feature_flag": "FF_MY_FEATURE_FLAG",
@@ -5160,6 +5179,9 @@ const { data } = await client.createSchemaCapability(
     _purpose: ['taxonomy-slug:classification-slug'],
     _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
     app_id: '123e4567-e89b-12d3-a456-426614174000',
+    adjust_installment: {
+      journey_id: 'adjust-installment-flow'
+    },
     ui_config: {
       is_filterable: true
     },
@@ -5289,6 +5311,9 @@ const { data } = await client.createSchemaCapability(
   "_purpose": ["taxonomy-slug:classification-slug"],
   "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "app_id": "123e4567-e89b-12d3-a456-426614174000",
+  "adjust_installment": {
+    "journey_id": "adjust-installment-flow"
+  },
   "ui_config": {
     "is_filterable": true
   },
@@ -5433,6 +5458,9 @@ const { data } = await client.getSchemaCapability({
   "_purpose": ["taxonomy-slug:classification-slug"],
   "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "app_id": "123e4567-e89b-12d3-a456-426614174000",
+  "adjust_installment": {
+    "journey_id": "adjust-installment-flow"
+  },
   "ui_config": {
     "is_filterable": true
   },
@@ -5573,6 +5601,9 @@ const { data } = await client.putSchemaCapability(
     _purpose: ['taxonomy-slug:classification-slug'],
     _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
     app_id: '123e4567-e89b-12d3-a456-426614174000',
+    adjust_installment: {
+      journey_id: 'adjust-installment-flow'
+    },
     ui_config: {
       is_filterable: true
     },
@@ -5702,6 +5733,9 @@ const { data } = await client.putSchemaCapability(
   "_purpose": ["taxonomy-slug:classification-slug"],
   "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "app_id": "123e4567-e89b-12d3-a456-426614174000",
+  "adjust_installment": {
+    "journey_id": "adjust-installment-flow"
+  },
   "ui_config": {
     "is_filterable": true
   },
@@ -5846,6 +5880,9 @@ const { data } = await client.deleteSchemaCapability({
   "_purpose": ["taxonomy-slug:classification-slug"],
   "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
   "app_id": "123e4567-e89b-12d3-a456-426614174000",
+  "adjust_installment": {
+    "journey_id": "adjust-installment-flow"
+  },
   "ui_config": {
     "is_filterable": true
   },
@@ -9511,6 +9548,16 @@ URL-friendly identifier for the entity schema
 type EntitySlug = string
 ```
 
+### `AdjustInstallmentCapabilityConfig`
+
+Configuration for adjusting a contract installment through a Journey.
+
+```ts
+type AdjustInstallmentCapabilityConfig = {
+  journey_id: string
+}
+```
+
 ### `EntityCapability`
 
 Capabilities the Entity has. Turn features on/off for entities.

packages/epilot-sdk-v2/src/types/entity.d.ts

@@ -835,6 +835,15 @@ export declare namespace Components {
              */
             DefaultAddressFields;
         }
+        /**
+         * Configuration for adjusting a contract installment through a Journey.
+         */
+        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
@@ -3313,6 +3322,7 @@ export declare namespace Components {
              * 123e4567-e89b-12d3-a456-426614174000
              */
             app_id?: string;
+            adjust_installment?: /* Configuration for adjusting a contract installment through a Journey. */ AdjustInstallmentCapabilityConfig;
             ui_config?: {
                 /**
                  * Whether the capability is filterable
@@ -3458,6 +3468,7 @@ export declare namespace Components {
              * 123e4567-e89b-12d3-a456-426614174000
              */
             app_id?: string;
+            adjust_installment?: /* Configuration for adjusting a contract installment through a Journey. */ AdjustInstallmentCapabilityConfig;
             ui_config?: {
                 /**
                  * Whether the capability is filterable
@@ -19437,6 +19448,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;