@d19n/youfibre-odin-sdk 2.0.376 → 2.0.378

package/dist/entities-v2/DocumentValue.js

@@ -0,0 +1,130 @@
+"use strict";
+/**
+ * DocumentValue Entity Definition
+ *
+ * One extracted value of a document: the field, the value, where it came from (section, quote, page), the model's confidence, and its review state. Linked to the Document.
+ *
+ * @module AiModule
+ * @entity DocumentValue
+ * @schemaId 96afdaae-fb15-4a46-bb1c-67ef9509e02d
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_DELETED = exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_UPDATED = exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_CREATED = exports.ROUTING_KEY_DOCUMENT_VALUE_DELETED = exports.ROUTING_KEY_DOCUMENT_VALUE_UPDATED = exports.ROUTING_KEY_DOCUMENT_VALUE_CREATED = exports.DocumentValue = exports.DocumentValuePropertyKeys = exports.DocumentValueReviewState = exports.DocumentValueKind = exports.DocumentValueEntityTypes = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Available types for DocumentValue records
+ */
+var DocumentValueEntityTypes;
+(function (DocumentValueEntityTypes) {
+    /** This is the default record type */
+    DocumentValueEntityTypes["DEFAULT"] = "DEFAULT";
+})(DocumentValueEntityTypes = exports.DocumentValueEntityTypes || (exports.DocumentValueEntityTypes = {}));
+/**
+ * Valid values for DocumentValue.Kind
+ *
+ * The type of the value, from the field list.
+ *
+ * @remarks Available options:
+ * - `BOOLEAN` - Boolean
+ * - `DATE` - Date
+ * - `MONEY` - Money
+ * - `NUMBER` - Number
+ * - `PARTY` - Party
+ * - `TEXT` - Text
+ */
+var DocumentValueKind;
+(function (DocumentValueKind) {
+    DocumentValueKind["BOOLEAN"] = "BOOLEAN";
+    DocumentValueKind["DATE"] = "DATE";
+    DocumentValueKind["MONEY"] = "MONEY";
+    DocumentValueKind["NUMBER"] = "NUMBER";
+    DocumentValueKind["PARTY"] = "PARTY";
+    DocumentValueKind["TEXT"] = "TEXT";
+})(DocumentValueKind = exports.DocumentValueKind || (exports.DocumentValueKind = {}));
+/**
+ * Valid values for DocumentValue.ReviewState
+ *
+ * Where the value stands with a person: needs review, confirmed, corrected, or not found in the document.
+ *
+ * @remarks Available options:
+ * - `CONFIRMED` - Confirmed
+ * - `CORRECTED` - Corrected
+ * - `NEEDS_REVIEW` - Needs review
+ * - `NOT_FOUND` - Not found
+ */
+var DocumentValueReviewState;
+(function (DocumentValueReviewState) {
+    DocumentValueReviewState["CONFIRMED"] = "CONFIRMED";
+    DocumentValueReviewState["CORRECTED"] = "CORRECTED";
+    DocumentValueReviewState["NEEDS_REVIEW"] = "NEEDS_REVIEW";
+    DocumentValueReviewState["NOT_FOUND"] = "NOT_FOUND";
+})(DocumentValueReviewState = exports.DocumentValueReviewState || (exports.DocumentValueReviewState = {}));
+/**
+ * Property keys for DocumentValue
+ * Use these constants instead of string literals for type safety
+ */
+var DocumentValuePropertyKeys;
+(function (DocumentValuePropertyKeys) {
+    /** The field name from the field list for the document type, e.g. GoverningLaw, PaymentDays. */
+    DocumentValuePropertyKeys["Field"] = "Field";
+    /** The type of the value, from the field list. */
+    DocumentValuePropertyKeys["Kind"] = "Kind";
+    /** The value as text, after any correction. Blank when the document does not state it (see ReviewState NOT_FOUND). */
+    DocumentValuePropertyKeys["Value"] = "Value";
+    /** What the model extracted, kept beside a correction. Equal to Value until a person corrects it. */
+    DocumentValuePropertyKeys["ModelValue"] = "ModelValue";
+    /** The field list the value was extracted with, e.g. NDA. */
+    DocumentValuePropertyKeys["SchemaName"] = "SchemaName";
+    /** The version of that field list. */
+    DocumentValuePropertyKeys["SchemaVersion"] = "SchemaVersion";
+    /** How sure the model was, 0 to 1. */
+    DocumentValuePropertyKeys["Confidence"] = "Confidence";
+    /** The id of the section in sections.json the value was read from. */
+    DocumentValuePropertyKeys["SectionId"] = "SectionId";
+    /** The passage, copied word for word from that section, the value rests on; checked against the stored text before the row is written. */
+    DocumentValuePropertyKeys["Quote"] = "Quote";
+    /** The page of the section. */
+    DocumentValuePropertyKeys["Page"] = "Page";
+    /** Where the value stands with a person: needs review, confirmed, corrected, or not found in the document. */
+    DocumentValuePropertyKeys["ReviewState"] = "ReviewState";
+    /** The user who confirmed or corrected the value. */
+    DocumentValuePropertyKeys["ReviewedBy"] = "ReviewedBy";
+    /** When the value was confirmed or corrected. */
+    DocumentValuePropertyKeys["ReviewedAt"] = "ReviewedAt";
+})(DocumentValuePropertyKeys = exports.DocumentValuePropertyKeys || (exports.DocumentValuePropertyKeys = {}));
+/**
+ * DocumentValue entity from AiModule
+ *
+ * One extracted value of a document: the field, the value, where it came from (section, quote, page), the model's confidence, and its review state. Linked to the Document.
+ *
+ * @module AiModule
+ * @entity DocumentValue
+ * @schemaId 96afdaae-fb15-4a46-bb1c-67ef9509e02d
+ * @recordPrefix DOV
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+class DocumentValue extends core_1.OdinRecord {
+}
+exports.DocumentValue = DocumentValue;
+// ============================================
+// RABBITMQ EVENT ROUTING KEYS
+// ============================================
+/**
+ * RabbitMQ routing keys for DocumentValue events
+ */
+exports.ROUTING_KEY_DOCUMENT_VALUE_CREATED = 'AiModule.DocumentValue.SubDbRecordCreated';
+exports.ROUTING_KEY_DOCUMENT_VALUE_UPDATED = 'AiModule.DocumentValue.SubDbRecordUpdated';
+exports.ROUTING_KEY_DOCUMENT_VALUE_DELETED = 'AiModule.DocumentValue.SubDbRecordDeleted';
+/**
+ * Type-specific routing keys for DocumentValue events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_CREATED = 'AiModule.DocumentValue.DEFAULT.SubDbRecordCreated';
+/** This is the default record type updated */
+exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_UPDATED = 'AiModule.DocumentValue.DEFAULT.SubDbRecordUpdated';
+/** This is the default record type deleted */
+exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_DELETED = 'AiModule.DocumentValue.DEFAULT.SubDbRecordDeleted';

package/dist/entities-v2/Order.d.ts

@@ -616,7 +616,9 @@ export declare enum OrderPropertyKeys {
     /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle. */
     EarliestDueAt = "EarliestDueAt",
     /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493). */
-    RouterUpgradeDeclined = "RouterUpgradeDeclined"
+    RouterUpgradeDeclined = "RouterUpgradeDeclined",
+    /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does. */
+    FirstRequestedActivationDate = "FirstRequestedActivationDate"
 }
 /**
  * Properties for Order records
@@ -1305,6 +1307,12 @@ export interface OrderProperties {
      * @default
      */
     RouterUpgradeDeclined: boolean;
+    /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does.
+     *
+     * @type {DATE}
+     * @default
+     */
+    FirstRequestedActivationDate: string;
 }
 /**
  * Order entity from OrderModule

package/dist/entities-v2/Order.js

@@ -600,6 +600,8 @@ var OrderPropertyKeys;
     OrderPropertyKeys["EarliestDueAt"] = "EarliestDueAt";
     /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493). */
     OrderPropertyKeys["RouterUpgradeDeclined"] = "RouterUpgradeDeclined";
+    /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does. */
+    OrderPropertyKeys["FirstRequestedActivationDate"] = "FirstRequestedActivationDate";
 })(OrderPropertyKeys = exports.OrderPropertyKeys || (exports.OrderPropertyKeys = {}));
 /**
  * Order entity from OrderModule

package/dist/entities-v2/QaReport.d.ts

@@ -164,7 +164,11 @@ export declare enum QaReportPropertyKeys {
     /** Optional note from the manager about the amendment as a whole. */
     AmendmentNote = "AmendmentNote",
     /** The bulk QA run this report was generated by. Empty for a report generated from the case tab. */
-    BatchId = "BatchId"
+    BatchId = "BatchId",
+    /** The model's verdict per rubric item key, the auto-fails it triggered and PASS/FAIL, as {"result","items","autoFails"}. Written once with the report; never changed. */
+    ItemVerdicts = "ItemVerdicts",
+    /** The same shape as ItemVerdicts after a manager's amendment. Empty when the report has not been amended; cleared on restore. */
+    AmendedItemVerdicts = "AmendedItemVerdicts"
 }
 /**
  * Properties for QaReport records
@@ -358,6 +362,18 @@ export interface QaReportProperties {
      * @default
      */
     BatchId: string;
+    /** The model's verdict per rubric item key, the auto-fails it triggered and PASS/FAIL, as {"result","items","autoFails"}. Written once with the report; never changed.
+     *
+     * @type {JSON}
+     * @default
+     */
+    ItemVerdicts: string;
+    /** The same shape as ItemVerdicts after a manager's amendment. Empty when the report has not been amended; cleared on restore.
+     *
+     * @type {JSON}
+     * @default
+     */
+    AmendedItemVerdicts: string;
 }
 /**
  * QaReport entity from SupportModule

package/dist/entities-v2/QaReport.js

@@ -172,6 +172,10 @@ var QaReportPropertyKeys;
     QaReportPropertyKeys["AmendmentNote"] = "AmendmentNote";
     /** The bulk QA run this report was generated by. Empty for a report generated from the case tab. */
     QaReportPropertyKeys["BatchId"] = "BatchId";
+    /** The model's verdict per rubric item key, the auto-fails it triggered and PASS/FAIL, as {"result","items","autoFails"}. Written once with the report; never changed. */
+    QaReportPropertyKeys["ItemVerdicts"] = "ItemVerdicts";
+    /** The same shape as ItemVerdicts after a manager's amendment. Empty when the report has not been amended; cleared on restore. */
+    QaReportPropertyKeys["AmendedItemVerdicts"] = "AmendedItemVerdicts";
 })(QaReportPropertyKeys = exports.QaReportPropertyKeys || (exports.QaReportPropertyKeys = {}));
 /**
  * QaReport entity from SupportModule

package/dist/entities-v2/Recontract.d.ts

@@ -58,12 +58,14 @@ export declare enum DefaultRecontractStageKeys {
  * - `AGENT` - Agent
  * - `CUSTOMER_APP` - Customer App
  * - `CUSTOMER_PORTAL` - Customer Portal
+ * - `SPEED_CHANGE` - Speed Change
  * - `WEB_RECONTRACT` - Website
  */
 export declare enum RecontractSource {
     AGENT = "AGENT",
     CUSTOMER_APP = "CUSTOMER_APP",
     CUSTOMER_PORTAL = "CUSTOMER_PORTAL",
+    SPEED_CHANGE = "SPEED_CHANGE",
     WEBSITE = "WEB_RECONTRACT"
 }
 /**

package/dist/entities-v2/Recontract.js

@@ -62,6 +62,7 @@ var DefaultRecontractStageKeys;
  * - `AGENT` - Agent
  * - `CUSTOMER_APP` - Customer App
  * - `CUSTOMER_PORTAL` - Customer Portal
+ * - `SPEED_CHANGE` - Speed Change
  * - `WEB_RECONTRACT` - Website
  */
 var RecontractSource;
@@ -69,6 +70,7 @@ var RecontractSource;
     RecontractSource["AGENT"] = "AGENT";
     RecontractSource["CUSTOMER_APP"] = "CUSTOMER_APP";
     RecontractSource["CUSTOMER_PORTAL"] = "CUSTOMER_PORTAL";
+    RecontractSource["SPEED_CHANGE"] = "SPEED_CHANGE";
     RecontractSource["WEBSITE"] = "WEB_RECONTRACT";
 })(RecontractSource = exports.RecontractSource || (exports.RecontractSource = {}));
 /**

package/dist/entities-v2/WorkOrder.d.ts

@@ -795,14 +795,14 @@ export declare enum WorkOrderCpe4 {
  * - `NO_SPEED_UPGRADE_ONT_REPLACEMENT_REQUIRED` - [NO] Speed Upgrade – ONT Replacement Required
  * - `NO_SPEED_UPGRADE_ONT_ROUTER_AND_MESH_REPLACEMENT_REQ` - [NO] Speed Upgrade – ONT Router & Mesh Replacement Req
  * - `NO_SPEED_UPGRADE_ONT_AND_ROUTER_REPLACEMENT_REQUIRED` - [NO] Speed Upgrade - ONT & Router Replacement Required
+ * - `NO_START_ORDER_ONT_OFFLINE` - [NO] Start Order - ONT Offline
  * - `NO_TLOS_BIP_ERRORS` - [NO] Tlos Bip Errors
  * - `NO_TLOS_DAMAGED_FIBRE` - [NO] Tlos Damaged Fibre
  * - `NO_TLOS_ONT_DOWN` - [NO] Tlos Ont Down
  * - `RXP_PROJECT` - RXP Project
  * - `YF_CANCEL_WO_SPEAK_TO_CUSTOMER` - [YF] Cancel WO Speak To Customer
  * - `YF_CITY_FIBRE_NEW_INSTALLATION` - [YF] City Fibre New Installation
- * - `YF_CONNECTION_DROP_OUTS` - [YF] Connection Drop Outs
- * - ... and 12 more
+ * - ... and 13 more
  */
 export declare enum WorkOrderServiceCallReason {
     NO_ACTIVATION_FAILED_ONT_NOT_READY = "NO_ACTIVATION_FAILED_ONT_NOT_READY",
@@ -813,6 +813,7 @@ export declare enum WorkOrderServiceCallReason {
     NO_SPEED_UPGRADE_ONT_REPLACEMENT_REQUIRED = "NO_SPEED_UPGRADE_ONT_REPLACEMENT_REQUIRED",
     NO_SPEED_UPGRADE_ONT_ROUTER_MESH_REPLACEMENT_REQ = "NO_SPEED_UPGRADE_ONT_ROUTER_AND_MESH_REPLACEMENT_REQ",
     NO_SPEED_UPGRADE_ONT_ROUTER_REPLACEMENT_REQUIRED = "NO_SPEED_UPGRADE_ONT_AND_ROUTER_REPLACEMENT_REQUIRED",
+    NO_START_ORDER_ONT_OFFLINE = "NO_START_ORDER_ONT_OFFLINE",
     NO_TLOS_BIP_ERRORS = "NO_TLOS_BIP_ERRORS",
     NO_TLOS_DAMAGED_FIBRE = "NO_TLOS_DAMAGED_FIBRE",
     NO_TLOS_ONT_DOWN = "NO_TLOS_ONT_DOWN",

package/dist/entities-v2/WorkOrder.js

@@ -768,14 +768,14 @@ var WorkOrderCpe4;
  * - `NO_SPEED_UPGRADE_ONT_REPLACEMENT_REQUIRED` - [NO] Speed Upgrade – ONT Replacement Required
  * - `NO_SPEED_UPGRADE_ONT_ROUTER_AND_MESH_REPLACEMENT_REQ` - [NO] Speed Upgrade – ONT Router & Mesh Replacement Req
  * - `NO_SPEED_UPGRADE_ONT_AND_ROUTER_REPLACEMENT_REQUIRED` - [NO] Speed Upgrade - ONT & Router Replacement Required
+ * - `NO_START_ORDER_ONT_OFFLINE` - [NO] Start Order - ONT Offline
  * - `NO_TLOS_BIP_ERRORS` - [NO] Tlos Bip Errors
  * - `NO_TLOS_DAMAGED_FIBRE` - [NO] Tlos Damaged Fibre
  * - `NO_TLOS_ONT_DOWN` - [NO] Tlos Ont Down
  * - `RXP_PROJECT` - RXP Project
  * - `YF_CANCEL_WO_SPEAK_TO_CUSTOMER` - [YF] Cancel WO Speak To Customer
  * - `YF_CITY_FIBRE_NEW_INSTALLATION` - [YF] City Fibre New Installation
- * - `YF_CONNECTION_DROP_OUTS` - [YF] Connection Drop Outs
- * - ... and 12 more
+ * - ... and 13 more
  */
 var WorkOrderServiceCallReason;
 (function (WorkOrderServiceCallReason) {
@@ -787,6 +787,7 @@ var WorkOrderServiceCallReason;
     WorkOrderServiceCallReason["NO_SPEED_UPGRADE_ONT_REPLACEMENT_REQUIRED"] = "NO_SPEED_UPGRADE_ONT_REPLACEMENT_REQUIRED";
     WorkOrderServiceCallReason["NO_SPEED_UPGRADE_ONT_ROUTER_MESH_REPLACEMENT_REQ"] = "NO_SPEED_UPGRADE_ONT_ROUTER_AND_MESH_REPLACEMENT_REQ";
     WorkOrderServiceCallReason["NO_SPEED_UPGRADE_ONT_ROUTER_REPLACEMENT_REQUIRED"] = "NO_SPEED_UPGRADE_ONT_AND_ROUTER_REPLACEMENT_REQUIRED";
+    WorkOrderServiceCallReason["NO_START_ORDER_ONT_OFFLINE"] = "NO_START_ORDER_ONT_OFFLINE";
     WorkOrderServiceCallReason["NO_TLOS_BIP_ERRORS"] = "NO_TLOS_BIP_ERRORS";
     WorkOrderServiceCallReason["NO_TLOS_DAMAGED_FIBRE"] = "NO_TLOS_DAMAGED_FIBRE";
     WorkOrderServiceCallReason["NO_TLOS_ONT_DOWN"] = "NO_TLOS_ONT_DOWN";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d19n/youfibre-odin-sdk",
-  "version": "2.0.376",
+  "version": "2.0.378",
   "description": "",
   "author": "@d19n",
   "license": "UNLICENSED",