From 5f95a33ac2e8dd1d69fcfeb4c08b4d06415169bc Mon Sep 17 00:00:00 2001 From: ci core model Date: Tue, 8 Sep 2026 12:10:35 +0000 Subject: [PATCH] Latest generation --- package.json | 2 +- ruleEngine_model.ts | 224 ++++++++++++++++++++--------------------- ruleEngine_services.ts | 66 ++++++------ 3 files changed, 146 insertions(+), 146 deletions(-) diff --git a/package.json b/package.json index c91684c..d8021d7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@reflex-platform/npm-core-sdk", - "version": "1.15.0-SNAPSHOT-260908112918", + "version": "1.15.0-SNAPSHOT-260908120948", "description": "npm libs from core model proto files", "homepage": "", "main": "index.ts", diff --git a/ruleEngine_model.ts b/ruleEngine_model.ts index f81d291..5919933 100644 --- a/ruleEngine_model.ts +++ b/ruleEngine_model.ts @@ -39,33 +39,33 @@ export interface EngineRule { /** * @generated from protobuf field: string Code = 20 */ - Code: string; // Unique code for the rule, e.g. "ApplyFreeShipping" + Code: string; // Unique code for the rule, e.g. "ApplyFreeShipping". /** * @generated from protobuf field: string Label = 30 */ - Label: string; // Human-readable label of the rule's purpose + Label: string; // Human-readable label of the rule's purpose. /** * @generated from protobuf field: api.EngineRuleValidityType ValidityType = 40 */ - ValidityType: EngineRuleValidityType; // Whether the rule is always valid or only valid between a start and end date + ValidityType: EngineRuleValidityType; // Whether the rule is always valid or only valid between a start and end date. /** * @generated from protobuf field: string ValidFrom = 41 */ - ValidFrom: string; // Only meaningful when ValidityType = DATE_RANGE; ignored otherwise + ValidFrom: string; // Only meaningful when ValidityType = DATE_RANGE; ignored otherwise. /** * @generated from protobuf field: string ValidUntil = 42 */ - ValidUntil: string; // Only meaningful when ValidityType = DATE_RANGE; ignored otherwise + ValidUntil: string; // Only meaningful when ValidityType = DATE_RANGE; ignored otherwise. /** * @generated from protobuf field: api.EntityType Entity = 50 */ - Entity: EntityType; // Entity type this rule applies to (Order, HandlingUnit, etc.) + Entity: EntityType; // Entity type this rule applies to (Order, HandlingUnit, etc.). /** * @generated from protobuf field: api.EngineRuleTriggerType TriggerType = 60 */ - TriggerType: EngineRuleTriggerType; // Type of trigger that will cause the rule to be evaluated + TriggerType: EngineRuleTriggerType; // Type of trigger that will cause the rule to be evaluated. /** - * What causes the rule to be evaluated + * What causes the rule to be evaluated. * * @generated from protobuf oneof: Trigger */ @@ -74,38 +74,38 @@ export interface EngineRule { /** * @generated from protobuf field: api.EngineRuleScheduledTrigger ScheduledTrigger = 70 */ - ScheduledTrigger: EngineRuleScheduledTrigger; // Triggered on a schedule defined by a partial RRule model + ScheduledTrigger: EngineRuleScheduledTrigger; // Triggered on a schedule defined by a partial RRule model. } | { oneofKind: "EventTrigger"; /** * @generated from protobuf field: api.EngineRuleEventTrigger EventTrigger = 71 */ - EventTrigger: EngineRuleEventTrigger; // Triggered when the entity is created, deleted, or changes status + EventTrigger: EngineRuleEventTrigger; // Triggered when the entity is created, deleted, or changes status. } | { oneofKind: "MilestoneTrigger"; /** * @generated from protobuf field: api.EngineRuleMilestoneTrigger MilestoneTrigger = 72 */ - MilestoneTrigger: EngineRuleMilestoneTrigger; // Triggered when a logistics milestone is reached + MilestoneTrigger: EngineRuleMilestoneTrigger; // Triggered when a logistics milestone is reached. } | { oneofKind: undefined; }; /** * @generated from protobuf field: repeated api.EngineRuleCondition Conditions = 80 */ - Conditions: EngineRuleCondition[]; // All conditions evaluated with AND semantics; no conditions = unconditional trigger + Conditions: EngineRuleCondition[]; // All conditions evaluated with AND semantics; no conditions = unconditional trigger. /** * @generated from protobuf field: repeated api.EngineRuleAction Actions = 90 */ - Actions: EngineRuleAction[]; // Actions to execute when the rule is triggered and all conditions are met + Actions: EngineRuleAction[]; // Actions to execute when the rule is triggered and all conditions are met. /** * @generated from protobuf field: repeated api.EngineRuleAction ElseActions = 91 */ - ElseActions: EngineRuleAction[]; // Actions to execute when the rule is triggered but at least one condition is not met (Else branch); may be empty + ElseActions: EngineRuleAction[]; // Actions to execute when the rule is triggered but at least one condition is not met (Else branch); may be empty. /** * @generated from protobuf field: int32 Version = 100 */ - Version: number; // incremented on each update + Version: number; // incremented on each update. /** * @generated from protobuf field: string CreatedBy = 110 */ @@ -121,7 +121,7 @@ export interface EngineRule { /** * @generated from protobuf field: bool IsActive = 140 */ - IsActive: boolean; // Whether the rule is currently active, independent of its ValidityType and ValidFrom/ValidUntil dates + IsActive: boolean; // Whether the rule is currently active, independent of its ValidityType and ValidFrom/ValidUntil dates. } // ─── Trigger ────────────────────────────────────────────────────────────────── // What causes the rule to be evaluated : a schedule, a status change, or a milestone. @@ -139,11 +139,11 @@ export interface EngineRuleScheduledTrigger { /** * @generated from protobuf field: int32 Interval = 2 */ - Interval: number; // e.g. Frequency = MINUTELY, Interval = 10 -> every 10 minutes; defaults to 1 at application layer + Interval: number; // e.g. Frequency = MINUTELY, Interval = 10 -> every 10 minutes; defaults to 1 at application layer. /** * @generated from protobuf field: repeated api.WeekDay ByDay = 3 */ - ByDay: WeekDay[]; // Only meaningful when Frequency = WEEKLY; ignored otherwise + ByDay: WeekDay[]; // Only meaningful when Frequency = WEEKLY; ignored otherwise. /** * @generated from protobuf field: string StartDate = 4 */ @@ -171,19 +171,19 @@ export interface EngineRuleEventTrigger { /** * @generated from protobuf field: api.EngineRuleEventTriggerCreation Creation = 1 */ - Creation: EngineRuleEventTriggerCreation; // Triggered when the entity is created + Creation: EngineRuleEventTriggerCreation; // Triggered when the entity is created. } | { oneofKind: "Deletion"; /** * @generated from protobuf field: api.EngineRuleEventTriggerDeletion Deletion = 2 */ - Deletion: EngineRuleEventTriggerDeletion; // Triggered when the entity is deleted + Deletion: EngineRuleEventTriggerDeletion; // Triggered when the entity is deleted. } | { oneofKind: "StatusChange"; /** * @generated from protobuf field: api.EngineRuleEventTriggerStatusChange StatusChange = 3 */ - StatusChange: EngineRuleEventTriggerStatusChange; // Triggered when the entity changes status + StatusChange: EngineRuleEventTriggerStatusChange; // Triggered when the entity changes status. } | { oneofKind: undefined; }; @@ -285,7 +285,7 @@ export interface EngineRuleMilestoneTrigger { /** * @generated from protobuf field: string MilestoneField = 1 */ - MilestoneField: string; // path to the Milestone field, e.g. "Order.RequestedMilestones.ContractualLogisticsDate" or "Order.MetaData.PickupRequested" + MilestoneField: string; // path to the Milestone field, e.g. "Order.RequestedMilestones.ContractualLogisticsDate" or "Order.MetaData.PickupRequested". } // ─── Conditions ─────────────────────────────────────────────────────────────── @@ -353,7 +353,7 @@ export interface EngineRuleCondition { /** * @generated from protobuf field: api.EngineRuleLiteralList LiteralListValue = 32 */ - LiteralListValue: EngineRuleLiteralList; // For IN operator + LiteralListValue: EngineRuleLiteralList; // For IN operator. } | { oneofKind: "FieldRefValue"; /** @@ -379,7 +379,7 @@ export interface EngineRuleCondition { /** * @generated from protobuf field: api.EngineRuleMappingRef MappingValue = 35 */ - MappingValue: EngineRuleMappingRef; // Reference to a reusable lookup table, e.g. compare Order.TotalAmount against a threshold that depends on Order.Priority + MappingValue: EngineRuleMappingRef; // Reference to a reusable lookup table, e.g. compare Order.TotalAmount against a threshold that depends on Order.Priority. } | { oneofKind: undefined; }; @@ -394,11 +394,11 @@ export interface EngineRuleConditionCollectionCriteria { /** * @generated from protobuf field: string CollectionPath = 1 */ - CollectionPath: string; // path to the collection, e.g. "Order.Lines" + CollectionPath: string; // path to the collection, e.g. "Order.Lines". /** * @generated from protobuf field: string ElementField = 2 */ - ElementField: string; // field on each element, e.g. "Quantity" + ElementField: string; // field on each element, e.g. "Quantity". /** * @generated from protobuf field: api.EngineRuleConditionQuantifier Quantifier = 3 */ @@ -495,7 +495,7 @@ export interface EngineRuleLiteralList { /** * @generated from protobuf field: repeated api.EngineRuleLiteral Items = 1 */ - Items: EngineRuleLiteral[]; // Must contain at least one value + Items: EngineRuleLiteral[]; // Must contain at least one value. } /** * A reference to another field, either from the root entity or relative to the @@ -507,7 +507,7 @@ export interface EngineRuleFieldRef { /** * @generated from protobuf field: string Path = 1 */ - Path: string; // e.g. "PreparedQuantity" or "Order.TotalAmount" + Path: string; // e.g. "PreparedQuantity" or "Order.TotalAmount". /** * @generated from protobuf field: api.EngineRuleFieldRefScope Scope = 2 */ @@ -522,7 +522,7 @@ export interface EngineRuleComputedRef { /** * @generated from protobuf field: string ComputationID = 1 */ - ComputationID: string; // Reference to a predefined computation strategy, e.g. "ComputeDaysSinceOrderCreated" + ComputationID: string; // Reference to a predefined computation strategy, e.g. "ComputeDaysSinceOrderCreated". } /** * Reference to an externally managed lookup table, shared across rules. @@ -534,7 +534,7 @@ export interface EngineRuleMappingRef { /** * @generated from protobuf field: string MappingID = 1 */ - MappingID: string; // Unique code identifying the lookup table + MappingID: string; // Unique code identifying the lookup table. } // ─── Actions ────────────────────────────────────────────────────────────────── @@ -552,19 +552,19 @@ export interface EngineRuleAction { /** * @generated from protobuf field: api.EngineRuleActionCreateClaim CreateClaim = 1 */ - CreateClaim: EngineRuleActionCreateClaim; // Requires a single target entity instance -- invalid for a set-based rule + CreateClaim: EngineRuleActionCreateClaim; // Requires a single target entity instance -- invalid for a set-based rule. } | { oneofKind: "UpdateMetadata"; /** * @generated from protobuf field: api.EngineRuleActionUpdateMetadata UpdateMetadata = 2 */ - UpdateMetadata: EngineRuleActionUpdateMetadata; // Requires a single target entity instance -- invalid for a set-based rule + UpdateMetadata: EngineRuleActionUpdateMetadata; // Requires a single target entity instance -- invalid for a set-based rule. } | { oneofKind: "CreateAlert"; /** * @generated from protobuf field: api.EngineRuleActionCreateAlert CreateAlert = 3 */ - CreateAlert: EngineRuleActionCreateAlert; // Global alert, not tied to any single entity instance -- the ONLY valid action for a set-based rule; also usable for a regular per-instance rule + CreateAlert: EngineRuleActionCreateAlert; // Global alert, not tied to any single entity instance -- the ONLY valid action for a set-based rule; also usable for a regular per-instance rule. } | { oneofKind: undefined; }; @@ -589,7 +589,7 @@ export interface EngineRuleActionUpdateMetadata { /** * @generated from protobuf field: string Field = 1 */ - Field: string; // Path to the field to update, e.g. "Status" or "Lines.PreparedQuantity" + Field: string; // Path to the field to update, e.g. "Status" or "Lines.PreparedQuantity". /** * @generated from protobuf field: api.EngineRuleActionAttributeValue Value = 2 */ @@ -606,7 +606,7 @@ export interface EngineRuleActionCreateAlert { /** * @generated from protobuf field: string Label = 1 */ - Label: string; // Human-readable alert message, e.g. "Stock périmé : valeur cumulée supérieure à 1500€" + Label: string; // Human-readable alert message, e.g. "Stock périmé : valeur cumulée supérieure à 1500€". } /** * The value to assign : either a literal, a computed function, or a mapping table. @@ -622,19 +622,19 @@ export interface EngineRuleActionAttributeValue { /** * @generated from protobuf field: api.EngineRuleLiteral LiteralValue = 1 */ - LiteralValue: EngineRuleLiteral; // Hardcoded typed value + LiteralValue: EngineRuleLiteral; // Hardcoded typed value. } | { oneofKind: "ComputedValue"; /** * @generated from protobuf field: api.EngineRuleComputedRef ComputedValue = 2 */ - ComputedValue: EngineRuleComputedRef; // Runtime function (deferred) + ComputedValue: EngineRuleComputedRef; // Runtime function (deferred). } | { oneofKind: "MappingValue"; /** * @generated from protobuf field: api.EngineRuleMappingRef MappingValue = 3 */ - MappingValue: EngineRuleMappingRef; // Reference to a reusable lookup table + MappingValue: EngineRuleMappingRef; // Reference to a reusable lookup table. } | { oneofKind: undefined; }; @@ -658,13 +658,13 @@ export interface Computation { /** * @generated from protobuf field: string Label = 30 */ - Label: string; // Human-readable label for the computation, e.g. "Compute Discount" + Label: string; // Human-readable label for the computation, e.g. "Compute Discount". /** * @generated from protobuf field: api.EntityType Entity = 40 */ - Entity: EntityType; // Entity type this computation applies to (Order, HandlingUnit, etc.) + Entity: EntityType; // Entity type this computation applies to (Order, HandlingUnit, etc.). /** - * The computation strategy to apply + * The computation strategy to apply. * * @generated from protobuf oneof: Type */ @@ -673,25 +673,25 @@ export interface Computation { /** * @generated from protobuf field: api.ComputationDateDuration DateDuration = 50 */ - DateDuration: ComputationDateDuration; // computes the duration between two date fields + DateDuration: ComputationDateDuration; // computes the duration between two date fields. } | { oneofKind: "DueDate"; /** * @generated from protobuf field: api.ComputationDueDate DueDate = 51 */ - DueDate: ComputationDueDate; // computes a due date from a reference date and a duration + DueDate: ComputationDueDate; // computes a due date from a reference date and a duration. } | { oneofKind: "StatusDuration"; /** * @generated from protobuf field: api.ComputationStatusDuration StatusDuration = 52 */ - StatusDuration: ComputationStatusDuration; // computes the cumulated duration spent in a set of statuses + StatusDuration: ComputationStatusDuration; // computes the cumulated duration spent in a set of statuses. } | { oneofKind: "CustomFunction"; /** * @generated from protobuf field: api.ComputationCustomFunction CustomFunction = 53 */ - CustomFunction: ComputationCustomFunction; // applies an arithmetic operator between two fields + CustomFunction: ComputationCustomFunction; // applies an arithmetic operator between two fields. } | { oneofKind: undefined; }; @@ -712,15 +712,15 @@ export interface ComputationDateDuration { /** * @generated from protobuf field: string StartDateField = 1 */ - StartDateField: string; // e.g. "Order.CreatedAt" + StartDateField: string; // e.g. "Order.CreatedAt". /** * @generated from protobuf field: string EndDateField = 2 */ - EndDateField: string; // e.g. "Order.ShippedAt" + EndDateField: string; // e.g. "Order.ShippedAt". /** * @generated from protobuf field: api.ComputationDurationFormat DurationFormat = 3 */ - DurationFormat?: ComputationDurationFormat; // How to express the resulting duration + DurationFormat?: ComputationDurationFormat; // How to express the resulting duration. } /** * Computes a due date by adding or subtracting a duration (fixed or looked up) to a reference date field. @@ -742,13 +742,13 @@ export interface ComputationDueDate { /** * @generated from protobuf field: string ReferenceDateField = 10 */ - ReferenceDateField: string; // e.g. "Order.CreatedAt" + ReferenceDateField: string; // e.g. "Order.CreatedAt". /** * @generated from protobuf field: api.ComputationDueDateComputationType ComputationType = 20 */ - ComputationType: ComputationDueDateComputationType; // Whether to add or subtract the duration + ComputationType: ComputationDueDateComputationType; // Whether to add or subtract the duration. /** - * The duration to apply: either a fixed date offset or a mapping-driven value + * The duration to apply: either a fixed date offset or a mapping-driven value. * * @generated from protobuf oneof: Value */ @@ -757,20 +757,20 @@ export interface ComputationDueDate { /** * @generated from protobuf field: uint32 Duration = 31 */ - Duration: number; // Duration which format is defined by DurationFormat, e.g. "3" with DurationFormat = DAYS means a 3-day duration + Duration: number; // Duration which format is defined by DurationFormat, e.g. "3" with DurationFormat = DAYS means a 3-day duration. } | { oneofKind: "MappingValue"; /** * @generated from protobuf field: api.EngineRuleMappingRef MappingValue = 32 */ - MappingValue: EngineRuleMappingRef; // Lookup table resolving a duration from the entity's fields, e.g. Order.Priority → days + MappingValue: EngineRuleMappingRef; // Lookup table resolving a duration from the entity's fields, e.g. Order.Priority → days. } | { oneofKind: undefined; }; /** * @generated from protobuf field: api.ComputationDurationFormat DurationFormat = 40 */ - DurationFormat?: ComputationDurationFormat; // How to express and round the resulting duration + DurationFormat?: ComputationDurationFormat; // How to express and round the resulting duration. } /** * Computes the cumulated duration the entity spent across a set of statuses. @@ -781,11 +781,11 @@ export interface ComputationStatusDuration { /** * @generated from protobuf field: repeated string StatusCodes = 1 */ - StatusCodes: string[]; // Status codes to accumulate duration for, e.g. ["ORDER_STATUS_SHIPPED", "ORDER_STATUS_DELIVERED"] + StatusCodes: string[]; // Status codes to accumulate duration for, e.g. ["ORDER_STATUS_SHIPPED", "ORDER_STATUS_DELIVERED"]. /** * @generated from protobuf field: api.ComputationDurationFormat DurationFormat = 2 */ - DurationFormat?: ComputationDurationFormat; // How to express the resulting duration + DurationFormat?: ComputationDurationFormat; // How to express the resulting duration. } /** * Defines how a duration is expressed and optionally rounded. @@ -803,19 +803,19 @@ export interface ComputationDurationFormat { /** * @generated from protobuf field: api.DurationFormat Format = 1 */ - Format: DurationFormat; // How to express the resulting duration (plain minutes/hours/days, or working-time equivalents) + Format: DurationFormat; // How to express the resulting duration (plain minutes/hours/days, or working-time equivalents). /** * @generated from protobuf field: string CalendarID = 2 */ - CalendarID: string; // Calendar to use for working-time calculations; only meaningful for WORKING_* formats + CalendarID: string; // Calendar to use for working-time calculations; only meaningful for WORKING_* formats. /** * @generated from protobuf field: api.DurationRounding Rounding = 3 */ - Rounding: DurationRounding; // How to round the resulting duration + Rounding: DurationRounding; // How to round the resulting duration. /** * @generated from protobuf field: string RoundingValue = 4 */ - RoundingValue: string; // If Rounding = FIXED_HOUR, the value to round to, e.g. "8:00:00" for an 8-hour rounding; ignored otherwise (must be in HH:MM:SS format) + RoundingValue: string; // If Rounding = FIXED_HOUR, the value to round to, e.g. "8:00:00" for an 8-hour rounding; ignored otherwise (must be in HH:MM:SS format). } /** * Applies an arithmetic operator between two entity fields and formats the result. @@ -826,7 +826,7 @@ export interface ComputationCustomFunction { /** * @generated from protobuf field: string LeftField = 1 */ - LeftField: string; // Left operand field path, e.g. "Order.TotalAmount" + LeftField: string; // Left operand field path, e.g. "Order.TotalAmount". /** * @generated from protobuf field: api.ComputationCustomFunctionOperator Operator = 2 */ @@ -834,11 +834,11 @@ export interface ComputationCustomFunction { /** * @generated from protobuf field: string RightField = 3 */ - RightField: string; // Right operand field path, e.g. "Order.DiscountAmount" + RightField: string; // Right operand field path, e.g. "Order.DiscountAmount". /** * @generated from protobuf field: api.ComputationCustomFunctionFormat Format = 4 */ - Format?: ComputationCustomFunctionFormat; // How to interpret and round the computed result + Format?: ComputationCustomFunctionFormat; // How to interpret and round the computed result. } /** * Defines how the result of a custom function is typed and rounded. @@ -853,7 +853,7 @@ export interface ComputationCustomFunctionFormat { /** * @generated from protobuf field: uint32 Precision = 2 */ - Precision: number; // Number of decimal places to round to + Precision: number; // Number of decimal places to round to. /** * @generated from protobuf field: api.CustomFunctionRounding Rounding = 3 */ @@ -873,27 +873,27 @@ export interface MappingTable { /** * @generated from protobuf field: string ID = 20 */ - ID: string; // Unique identifier for the mapping table, used in EngineRuleMappingRef + ID: string; // Unique identifier for the mapping table, used in EngineRuleMappingRef. /** * @generated from protobuf field: string Label = 30 */ - Label: string; // Human-readable label for the mapping table, e.g. "Shipping Cost by Priority" + Label: string; // Human-readable label for the mapping table, e.g. "Shipping Cost by Priority". /** * @generated from protobuf field: api.EntityType Entity = 40 */ - Entity: EntityType; // Entity type this mapping applies to (Order, HandlingUnit, etc.) + Entity: EntityType; // Entity type this mapping applies to (Order, HandlingUnit, etc.). /** * @generated from protobuf field: repeated api.MappingTableInputDescription InputFields = 50 */ - InputFields: MappingTableInputDescription[]; // Declarative schema: fields the table reads from the entity, e.g. ["Order.Priority", "Order.DestinationZone"]; application layer must ensure entries only reference fields listed here + InputFields: MappingTableInputDescription[]; // Declarative schema: fields the table reads from the entity, e.g. ["Order.Priority", "Order.DestinationZone"]; application layer must ensure entries only reference fields listed here. /** * @generated from protobuf field: api.MappingTableOutputField OutputField = 60 */ - OutputField?: MappingTableOutputField; // Field resulting from the lookup, e.g. "Shipping cost" + OutputField?: MappingTableOutputField; // Field resulting from the lookup, e.g. "Shipping cost". /** * @generated from protobuf field: repeated api.MappingTableEntry Entries = 70 */ - Entries: MappingTableEntry[]; // Mapping entries; must contain at least one entry + Entries: MappingTableEntry[]; // Mapping entries; must contain at least one entry. } /** * @generated from protobuf message api.MappingTableInputDescription @@ -902,7 +902,7 @@ export interface MappingTableInputDescription { /** * @generated from protobuf field: string Field = 1 */ - Field: string; // Field whose value is an input to the mapping table, e.g. "Order.Priority" + Field: string; // Field whose value is an input to the mapping table, e.g. "Order.Priority". /** * Reserved for date fields to indicate whether the mapping table expects full timestamps or truncated values (e.g. just date or just hour) and should apply appropriate transformations at * runtime @@ -918,11 +918,11 @@ export interface MappingTableEntry { /** * @generated from protobuf field: repeated api.MappingTableInput Inputs = 1 */ - Inputs: MappingTableInput[]; // input values driving the lookup, e.g. Order.Priority = "HIGH" + Inputs: MappingTableInput[]; // input values driving the lookup, e.g. Order.Priority = "HIGH". /** * @generated from protobuf field: api.EngineRuleLiteral OutputValue = 2 */ - OutputValue?: EngineRuleLiteral; // output value resulting from the lookup, e.g. ShippingCost = 25.00 + OutputValue?: EngineRuleLiteral; // output value resulting from the lookup, e.g. ShippingCost = 25.00. } /** * @generated from protobuf message api.MappingTableInput @@ -931,7 +931,7 @@ export interface MappingTableInput { /** * @generated from protobuf field: string Field = 10 */ - Field: string; // Field whose value is matched, must correspond to a field declared in MappingTable.InputFields, e.g. "Order.Priority" + Field: string; // Field whose value is matched, must correspond to a field declared in MappingTable.InputFields, e.g. "Order.Priority". /** * @generated from protobuf oneof: Value */ @@ -940,26 +940,26 @@ export interface MappingTableInput { /** * @generated from protobuf field: api.EngineRuleLiteral Literal = 20 */ - Literal: EngineRuleLiteral; // Value to match on the input field, e.g. "HIGH" + Literal: EngineRuleLiteral; // Value to match on the input field, e.g. "HIGH". } | { oneofKind: "LiteralList"; /** * @generated from protobuf field: api.EngineRuleLiteralList LiteralList = 22 */ - LiteralList: EngineRuleLiteralList; // Matches if the input field's value equals any one of these, e.g. ["HIGH", "URGENT"]; only meaningful with Operator = EQUALS + LiteralList: EngineRuleLiteralList; // Matches if the input field's value equals any one of these, e.g. ["HIGH", "URGENT"]; only meaningful with Operator = EQUALS. } | { oneofKind: "AllValuesMatch"; /** * @generated from protobuf field: bool AllValuesMatch = 21 */ - AllValuesMatch: boolean; // If true, the entry matches any value for the input field (wildcard); mutually exclusive with EngineRuleLiteral/LiteralList + AllValuesMatch: boolean; // If true, the entry matches any value for the input field (wildcard); mutually exclusive with EngineRuleLiteral/LiteralList. } | { oneofKind: undefined; }; /** * @generated from protobuf field: api.MappingTableInputOperator Operator = 30 */ - Operator: MappingTableInputOperator; // Operator to apply when matching the entry's input values to the entity's fields; defaults to EQUALS for exact match + Operator: MappingTableInputOperator; // Operator to apply when matching the entry's input values to the entity's fields; defaults to EQUALS for exact match. } /** * @generated from protobuf message api.MappingTableOutputField @@ -968,7 +968,7 @@ export interface MappingTableOutputField { /** * @generated from protobuf field: string Label = 1 */ - Label: string; // Human-readable label for the output field, e.g. "Shipping Cost" + Label: string; // Human-readable label for the output field, e.g. "Shipping Cost". /** * @generated from protobuf field: api.MappingTableOutputFieldType Type = 2 */ @@ -985,13 +985,13 @@ export enum EngineRuleValidityType { */ ENGINE_RULE_VALIDITY_TYPE_UNKNOWN = 0, /** - * rule is always valid + * rule is always valid. * * @generated from protobuf enum value: ENGINE_RULE_VALIDITY_TYPE_INDEFINITE = 1; */ ENGINE_RULE_VALIDITY_TYPE_INDEFINITE = 1, /** - * rule is valid between a start and end date + * rule is valid between a start and end date. * * @generated from protobuf enum value: ENGINE_RULE_VALIDITY_TYPE_DATE_RANGE = 2; */ @@ -1010,7 +1010,7 @@ export enum RuleRecurrenceFrequency { */ RULE_RECURRENCE_FREQUENCY_UNKNOWN = 0, /** - * Fires every Interval minutes, all day, every day starting at StartDate; AtTime/ByDay are ignored + * Fires every Interval minutes, all day, every day starting at StartDate; AtTime/ByDay are ignored. * * @generated from protobuf enum value: RULE_RECURRENCE_FREQUENCY_MINUTELY = 5; */ @@ -1020,7 +1020,7 @@ export enum RuleRecurrenceFrequency { */ RULE_RECURRENCE_FREQUENCY_DAILY = 1, /** - * Combine with ByDay to restrict to specific weekdays, e.g. Monday and Tuesday only + * Combine with ByDay to restrict to specific weekdays, e.g. Monday and Tuesday only. * * @generated from protobuf enum value: RULE_RECURRENCE_FREQUENCY_WEEKLY = 2; */ @@ -1066,19 +1066,19 @@ export enum EngineRuleConditionQuantifier { */ RULE_CONDITION_QUANTIFIER_UNKNOWN = 0, /** - * ∀ every element must satisfy the condition + * ∀ every element must satisfy the condition. * * @generated from protobuf enum value: RULE_CONDITION_QUANTIFIER_ALL = 1; */ RULE_CONDITION_QUANTIFIER_ALL = 1, /** - * ∃ at least one element must satisfy the condition + * ∃ at least one element must satisfy the condition. * * @generated from protobuf enum value: RULE_CONDITION_QUANTIFIER_ANY = 2; */ RULE_CONDITION_QUANTIFIER_ANY = 2, /** - * ∄ no element must satisfy the condition + * ∄ no element must satisfy the condition. * * @generated from protobuf enum value: RULE_CONDITION_QUANTIFIER_NONE = 3; */ @@ -1093,31 +1093,31 @@ export enum EngineRuleConditionAggregateFunction { */ RULE_CONDITION_AGGREGATE_FUNCTION_UNKNOWN = 0, /** - * Sum of Field across the filtered subset + * Sum of Field across the filtered subset. * * @generated from protobuf enum value: RULE_CONDITION_AGGREGATE_FUNCTION_SUM = 1; */ RULE_CONDITION_AGGREGATE_FUNCTION_SUM = 1, /** - * Number of instances in the filtered subset (Field is ignored) + * Number of instances in the filtered subset (Field is ignored). * * @generated from protobuf enum value: RULE_CONDITION_AGGREGATE_FUNCTION_COUNT = 2; */ RULE_CONDITION_AGGREGATE_FUNCTION_COUNT = 2, /** - * Average of Field across the filtered subset + * Average of Field across the filtered subset. * * @generated from protobuf enum value: RULE_CONDITION_AGGREGATE_FUNCTION_AVG = 3; */ RULE_CONDITION_AGGREGATE_FUNCTION_AVG = 3, /** - * Minimum value of Field across the filtered subset + * Minimum value of Field across the filtered subset. * * @generated from protobuf enum value: RULE_CONDITION_AGGREGATE_FUNCTION_MIN = 4; */ RULE_CONDITION_AGGREGATE_FUNCTION_MIN = 4, /** - * Maximum value of Field across the filtered subset + * Maximum value of Field across the filtered subset. * * @generated from protobuf enum value: RULE_CONDITION_AGGREGATE_FUNCTION_MAX = 5; */ @@ -1168,7 +1168,7 @@ export enum EngineRuleConditionOperator { */ RULE_CONDITION_OPERATOR_LESS_OR_EQUALS = 6, /** - * Value is in a list of literals + * Value is in a list of literals. * * @generated from protobuf enum value: RULE_CONDITION_OPERATOR_IN = 7; */ @@ -1183,13 +1183,13 @@ export enum EngineRuleFieldRefScope { */ ENGINE_RULE_FIELD_REF_SCOPE_UNKNOWN = 0, /** - * Path from root entity + * Path from root entity. * * @generated from protobuf enum value: ENGINE_RULE_FIELD_REF_SCOPE_ABSOLUTE = 1; */ ENGINE_RULE_FIELD_REF_SCOPE_ABSOLUTE = 1, /** - * Path relative to current collection element + * Path relative to current collection element. * * @generated from protobuf enum value: ENGINE_RULE_FIELD_REF_SCOPE_ELEMENT = 2; */ @@ -1204,13 +1204,13 @@ export enum ComputationDueDateComputationType { */ COMPUTATION_DUE_DATE_COMPUTATION_TYPE_UNKNOWN = 0, /** - * DueDate = ReferenceDate + ComputedDuration + * DueDate = ReferenceDate + ComputedDuration. * * @generated from protobuf enum value: COMPUTATION_DUE_DATE_COMPUTATION_TYPE_ADD = 1; */ COMPUTATION_DUE_DATE_COMPUTATION_TYPE_ADD = 1, /** - * DueDate = ReferenceDate - ComputedDuration + * DueDate = ReferenceDate - ComputedDuration. * * @generated from protobuf enum value: COMPUTATION_DUE_DATE_COMPUTATION_TYPE_SUBTRACT = 2; */ @@ -1229,7 +1229,7 @@ export enum DurationFormat { */ DURATION_FORMAT_MINUTES = 10, /** - * Excludes non-working time based on CalendarID + * Excludes non-working time based on CalendarID. * * @generated from protobuf enum value: DURATION_FORMAT_WORKING_MINUTES = 11; */ @@ -1239,7 +1239,7 @@ export enum DurationFormat { */ DURATION_FORMAT_HOURS = 20, /** - * Excludes non-working time based on CalendarID + * Excludes non-working time based on CalendarID. * * @generated from protobuf enum value: DURATION_FORMAT_WORKING_HOURS = 21; */ @@ -1249,7 +1249,7 @@ export enum DurationFormat { */ DURATION_FORMAT_DAYS = 30, /** - * Excludes non-working time based on CalendarID + * Excludes non-working time based on CalendarID. * * @generated from protobuf enum value: DURATION_FORMAT_WORKING_DAYS = 31; */ @@ -1264,19 +1264,19 @@ export enum DurationRounding { */ DURATION_ROUNDING_UNKNOWN = 0, /** - * round up to the next whole unit (e.g. 1h20m → 2h) + * round up to the next whole unit (e.g. 1h20m → 2h). * * @generated from protobuf enum value: DURATION_ROUNDING_UP = 1; */ DURATION_ROUNDING_UP = 1, /** - * round down to the previous whole unit (e.g. 1h20m → 1h) + * round down to the previous whole unit (e.g. 1h20m → 1h). * * @generated from protobuf enum value: DURATION_ROUNDING_DOWN = 2; */ DURATION_ROUNDING_DOWN = 2, /** - * round to the specified value (e.g 8h: 1h20m → 8h) + * round to the specified value (e.g 8h: 1h20m → 8h). * * @generated from protobuf enum value: DURATION_ROUNDING_FIXED_HOUR = 3; */ @@ -1324,13 +1324,13 @@ export enum CustomFunctionFormat { */ CUSTOM_FUNCTION_FORMAT_UNKNOWN = 0, /** - * e.g. 12.3456 + * e.g. 12.3456. * * @generated from protobuf enum value: CUSTOM_FUNCTION_FORMAT_NUMERIC = 1; */ CUSTOM_FUNCTION_FORMAT_NUMERIC = 1, /** - * e.g. 12.34% + * e.g. 12.34%. * * @generated from protobuf enum value: CUSTOM_FUNCTION_FORMAT_PERCENTAGE = 2; */ @@ -1345,13 +1345,13 @@ export enum CustomFunctionRounding { */ CUSTOM_FUNCTION_ROUNDING_UNKNOWN = 0, /** - * Round up to the next whole unit (e.g. 1.2 → 2) + * Round up to the next whole unit (e.g. 1.2 → 2). * * @generated from protobuf enum value: CUSTOM_FUNCTION_ROUNDING_UP = 1; */ CUSTOM_FUNCTION_ROUNDING_UP = 1, /** - * Round down to the previous whole unit (e.g. 1.2 → 1) + * Round down to the previous whole unit (e.g. 1.2 → 1). * * @generated from protobuf enum value: CUSTOM_FUNCTION_ROUNDING_DOWN = 2; */ @@ -1387,37 +1387,37 @@ export enum MappingTableInputOperator { */ MAPPING_TABLE_INPUT_OPERATOR_UNKNOWN = 0, /** - * Exact match of the timestamp + * Exact match of the timestamp. * * @generated from protobuf enum value: MAPPING_TABLE_INPUT_OPERATOR_EQUALS = 1; */ MAPPING_TABLE_INPUT_OPERATOR_EQUALS = 1, /** - * Does not match the timestamp + * Does not match the timestamp. * * @generated from protobuf enum value: MAPPING_TABLE_INPUT_OPERATOR_NOT_EQUALS = 2; */ MAPPING_TABLE_INPUT_OPERATOR_NOT_EQUALS = 2, /** - * Matches if the entity timestamp is before the input value + * Matches if the entity timestamp is before the input value. * * @generated from protobuf enum value: MAPPING_TABLE_INPUT_OPERATOR_LESS_THAN = 3; */ MAPPING_TABLE_INPUT_OPERATOR_LESS_THAN = 3, /** - * Matches if the entity timestamp is before or equal to the input value + * Matches if the entity timestamp is before or equal to the input value. * * @generated from protobuf enum value: MAPPING_TABLE_INPUT_OPERATOR_LESS_OR_EQUALS = 4; */ MAPPING_TABLE_INPUT_OPERATOR_LESS_OR_EQUALS = 4, /** - * Matches if the entity timestamp is after the input value + * Matches if the entity timestamp is after the input value. * * @generated from protobuf enum value: MAPPING_TABLE_INPUT_OPERATOR_GREATER_THAN = 5; */ MAPPING_TABLE_INPUT_OPERATOR_GREATER_THAN = 5, /** - * Matches if the entity timestamp is after or equal to the input value + * Matches if the entity timestamp is after or equal to the input value. * * @generated from protobuf enum value: MAPPING_TABLE_INPUT_OPERATOR_GREATER_OR_EQUALS = 6; */ diff --git a/ruleEngine_services.ts b/ruleEngine_services.ts index cb00129..3d6b2a2 100644 --- a/ruleEngine_services.ts +++ b/ruleEngine_services.ts @@ -49,7 +49,7 @@ export interface PutEngineRuleRequest { /** * @generated from protobuf field: string Label = 20 */ - Label: string; // Human-readable label of the rule's purpose + Label: string; // Human-readable label of the rule's purpose. /** * @generated from protobuf field: api.EngineRuleValidityType ValidityType = 30 */ @@ -57,17 +57,17 @@ export interface PutEngineRuleRequest { /** * @generated from protobuf field: string ValidFrom = 31 */ - ValidFrom: string; // optional start date for the rule's validity, only if ValidityType = DATE_RANGE + ValidFrom: string; // optional start date for the rule's validity, only if ValidityType = DATE_RANGE. /** * @generated from protobuf field: string ValidUntil = 32 */ - ValidUntil: string; // optional end date for the rule's validity, only if ValidityType = DATE_RANGE + ValidUntil: string; // optional end date for the rule's validity, only if ValidityType = DATE_RANGE. /** * @generated from protobuf field: api.EntityType Entity = 40 */ - Entity: EntityType; // Entity type this rule applies to (Order, HandlingUnit, etc.) + Entity: EntityType; // Entity type this rule applies to (Order, HandlingUnit, etc.). /** - * What causes the rule to be evaluated + * What causes the rule to be evaluated. * * @generated from protobuf oneof: Trigger */ @@ -76,34 +76,34 @@ export interface PutEngineRuleRequest { /** * @generated from protobuf field: api.EngineRuleScheduledTrigger ScheduledTrigger = 50 */ - ScheduledTrigger: EngineRuleScheduledTrigger; // triggered on a schedule defined by a partial RRule model + ScheduledTrigger: EngineRuleScheduledTrigger; // triggered on a schedule defined by a partial RRule model. } | { oneofKind: "EventTrigger"; /** * @generated from protobuf field: api.EngineRuleEventTrigger EventTrigger = 51 */ - EventTrigger: EngineRuleEventTrigger; // triggered when the entity is created, deleted, or changes status + EventTrigger: EngineRuleEventTrigger; // triggered when the entity is created, deleted, or changes status. } | { oneofKind: "MilestoneTrigger"; /** * @generated from protobuf field: api.EngineRuleMilestoneTrigger MilestoneTrigger = 52 */ - MilestoneTrigger: EngineRuleMilestoneTrigger; // triggered when a logistics milestone is reached + MilestoneTrigger: EngineRuleMilestoneTrigger; // triggered when a logistics milestone is reached. } | { oneofKind: undefined; }; /** * @generated from protobuf field: repeated api.EngineRuleCondition Conditions = 60 */ - Conditions: EngineRuleCondition[]; // All conditions evaluated with AND semantics; no conditions = unconditional trigger + Conditions: EngineRuleCondition[]; // All conditions evaluated with AND semantics; no conditions = unconditional trigger. /** * @generated from protobuf field: repeated api.EngineRuleAction Actions = 70 */ - Actions: EngineRuleAction[]; // Actions to execute when the rule is triggered and conditions are met + Actions: EngineRuleAction[]; // Actions to execute when the rule is triggered and conditions are met. /** * @generated from protobuf field: bool IsActive = 80 */ - IsActive: boolean; // whether the rule is currently active, independent of its ValidityType and ValidFrom/ValidUntil dates + IsActive: boolean; // whether the rule is currently active, independent of its ValidityType and ValidFrom/ValidUntil dates. } /** * @generated from protobuf message api.PutEngineRuleResponse @@ -151,11 +151,11 @@ export interface ListEngineRuleRequest { /** * @generated from protobuf field: api.EntityType Entity = 2 */ - Entity: EntityType; // Optional filter: only return rules applying to this entity type + Entity: EntityType; // Optional filter: only return rules applying to this entity type. /** * @generated from protobuf field: api.EngineRuleTriggerType TriggerType = 3 */ - TriggerType: EngineRuleTriggerType; // Optional filter: only return rules with this trigger type + TriggerType: EngineRuleTriggerType; // Optional filter: only return rules with this trigger type. /** * @generated from protobuf field: bool IsCurrentlyValid = 4 */ @@ -163,11 +163,11 @@ export interface ListEngineRuleRequest { /** * @generated from protobuf field: string Code = 5 */ - Code: string; // Optional filter: only return rules whose Code contains this value (case-insensitive substring match) + Code: string; // Optional filter: only return rules whose Code contains this value (case-insensitive substring match). /** * @generated from protobuf field: string Label = 6 */ - Label: string; // Optional filter: only return rules whose Label contains this value (case-insensitive substring match) + Label: string; // Optional filter: only return rules whose Label contains this value (case-insensitive substring match). } /** * @generated from protobuf message api.ListEngineRuleResponse @@ -180,7 +180,7 @@ export interface ListEngineRuleResponse { /** * @generated from protobuf field: int64 DebugUntil = 2 */ - DebugUntil: bigint; // Unix timestamp (seconds) until which debug mode is currently active for the project, if any; 0 if debug mode is not active + DebugUntil: bigint; // Unix timestamp (seconds) until which debug mode is currently active for the project, if any; 0 if debug mode is not active. } /** * Delete @@ -220,7 +220,7 @@ export interface ToggleDebugOnResponse { /** * @generated from protobuf field: int64 DebugUntil = 1 */ - DebugUntil: bigint; // Unix timestamp (seconds) until which debug mode will remain active for the project + DebugUntil: bigint; // Unix timestamp (seconds) until which debug mode will remain active for the project. } // ========== REQUESTS & RESPONSE MESSAGES ========== @@ -241,13 +241,13 @@ export interface PutComputationRequest { /** * @generated from protobuf field: string Label = 20 */ - Label: string; // Human-readable label for the computation, e.g. "Compute Discount" + Label: string; // Human-readable label for the computation, e.g. "Compute Discount". /** * @generated from protobuf field: api.EntityType Entity = 30 */ - Entity: EntityType; // Entity type this computation applies to (Order, HandlingUnit, etc.) + Entity: EntityType; // Entity type this computation applies to (Order, HandlingUnit, etc.). /** - * The computation strategy to apply + * The computation strategy to apply. * * @generated from protobuf oneof: Type */ @@ -256,25 +256,25 @@ export interface PutComputationRequest { /** * @generated from protobuf field: api.ComputationDateDuration DateDuration = 40 */ - DateDuration: ComputationDateDuration; // computes the duration between two date fields + DateDuration: ComputationDateDuration; // computes the duration between two date fields. } | { oneofKind: "DueDate"; /** * @generated from protobuf field: api.ComputationDueDate DueDate = 41 */ - DueDate: ComputationDueDate; // computes a due date from a reference date and a duration + DueDate: ComputationDueDate; // computes a due date from a reference date and a duration. } | { oneofKind: "StatusDuration"; /** * @generated from protobuf field: api.ComputationStatusDuration StatusDuration = 42 */ - StatusDuration: ComputationStatusDuration; // computes the cumulated duration spent in a set of statuses + StatusDuration: ComputationStatusDuration; // computes the cumulated duration spent in a set of statuses. } | { oneofKind: "CustomFunction"; /** * @generated from protobuf field: api.ComputationCustomFunction CustomFunction = 43 */ - CustomFunction: ComputationCustomFunction; // applies an arithmetic operator between two fields + CustomFunction: ComputationCustomFunction; // applies an arithmetic operator between two fields. } | { oneofKind: undefined; }; @@ -325,11 +325,11 @@ export interface ListComputationRequest { /** * @generated from protobuf field: api.EntityType Entity = 2 */ - Entity: EntityType; // Optional filter: only return computations applying to this entity type + Entity: EntityType; // Optional filter: only return computations applying to this entity type. /** * @generated from protobuf field: string Label = 3 */ - Label: string; // Optional filter: only return computations whose Label contains this value (case-insensitive substring match) + Label: string; // Optional filter: only return computations whose Label contains this value (case-insensitive substring match). } /** * @generated from protobuf message api.ListComputationResponse @@ -379,23 +379,23 @@ export interface PutMappingTableRequest { /** * @generated from protobuf field: string Label = 3 */ - Label: string; // Human-readable label for the mapping table, e.g. "Shipping Cost by Priority" + Label: string; // Human-readable label for the mapping table, e.g. "Shipping Cost by Priority". /** * @generated from protobuf field: api.EntityType Entity = 4 */ - Entity: EntityType; // Entity type this mapping applies to (Order, HandlingUnit, etc.) + Entity: EntityType; // Entity type this mapping applies to (Order, HandlingUnit, etc.). /** * @generated from protobuf field: repeated api.MappingTableInputDescription InputFields = 5 */ - InputFields: MappingTableInputDescription[]; // declarative schema: fields the table reads from the entity, e.g. ["Order.Priority", "Order.DestinationZone"]; Entries only reference InputFields listed here + InputFields: MappingTableInputDescription[]; // declarative schema: fields the table reads from the entity, e.g. ["Order.Priority", "Order.DestinationZone"]; Entries only reference InputFields listed here. /** * @generated from protobuf field: api.MappingTableOutputField OutputField = 6 */ - OutputField?: MappingTableOutputField; // field resulting from the lookup, e.g. "Shipping cost" + OutputField?: MappingTableOutputField; // field resulting from the lookup, e.g. "Shipping cost". /** * @generated from protobuf field: repeated api.MappingTableEntry Entries = 7 */ - Entries: MappingTableEntry[]; // mapping entries; must contain at least one entry + Entries: MappingTableEntry[]; // mapping entries; must contain at least one entry. } /** * @generated from protobuf message api.PutMappingTableResponse @@ -443,11 +443,11 @@ export interface ListMappingTableRequest { /** * @generated from protobuf field: api.EntityType Entity = 2 */ - Entity: EntityType; // Optional filter: only return mapping tables applying to this entity type + Entity: EntityType; // Optional filter: only return mapping tables applying to this entity type. /** * @generated from protobuf field: string Label = 3 */ - Label: string; // Optional filter: only return mapping tables whose Label contains this value (case-insensitive substring match) + Label: string; // Optional filter: only return mapping tables whose Label contains this value (case-insensitive substring match). } /** * @generated from protobuf message api.ListMappingTableResponse