@d19n/youfibre-odin-sdk 2.0.342 → 2.0.344

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

@@ -0,0 +1,66 @@
+/**
+ * EquipmentReturn Entity Definition
+ *
+ * One warehouse inspection of one returned parcel, against the collection or replacement work order that asked for it back. Holds the inspector, the notes and the verdict; the devices themselves are EquipmentReturnItem rows.
+ *
+ * @module FieldServiceModule
+ * @entity EquipmentReturn
+ * @schemaId d74a5bd0-d153-4dfb-ad8a-6c3233a3e0ce
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+import { OdinRecord } from '@d19n/odin-types/dist/core';
+/**
+ * Available types for EquipmentReturn records
+ */
+export declare enum EquipmentReturnEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * Property keys for EquipmentReturn
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum EquipmentReturnPropertyKeys {
+}
+/**
+ * Properties for EquipmentReturn records
+ *
+ * @see FieldServiceModule:EquipmentReturn
+ */
+export interface EquipmentReturnProperties {
+}
+/**
+ * EquipmentReturn entity from FieldServiceModule
+ *
+ * One warehouse inspection of one returned parcel, against the collection or replacement work order that asked for it back. Holds the inspector, the notes and the verdict; the devices themselves are EquipmentReturnItem rows.
+ *
+ * @module FieldServiceModule
+ * @entity EquipmentReturn
+ * @schemaId d74a5bd0-d153-4dfb-ad8a-6c3233a3e0ce
+ * @recordPrefix EQR
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+export declare class EquipmentReturn extends OdinRecord<EquipmentReturnProperties> {
+    entity: 'FieldServiceModule:EquipmentReturn';
+    type: EquipmentReturnEntityTypes;
+    schemaId: 'd74a5bd0-d153-4dfb-ad8a-6c3233a3e0ce';
+    properties: EquipmentReturnProperties;
+}
+/**
+ * RabbitMQ routing keys for EquipmentReturn events
+ */
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_CREATED = "FieldServiceModule.EquipmentReturn.SubDbRecordCreated";
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_UPDATED = "FieldServiceModule.EquipmentReturn.SubDbRecordUpdated";
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_DELETED = "FieldServiceModule.EquipmentReturn.SubDbRecordDeleted";
+/**
+ * Type-specific routing keys for EquipmentReturn events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_DEFAULT_CREATED = "FieldServiceModule.EquipmentReturn.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_DEFAULT_UPDATED = "FieldServiceModule.EquipmentReturn.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_DEFAULT_DELETED = "FieldServiceModule.EquipmentReturn.DEFAULT.SubDbRecordDeleted";

package/dist/entities-v2/EquipmentReturn.js

@@ -0,0 +1,64 @@
+"use strict";
+/**
+ * EquipmentReturn Entity Definition
+ *
+ * One warehouse inspection of one returned parcel, against the collection or replacement work order that asked for it back. Holds the inspector, the notes and the verdict; the devices themselves are EquipmentReturnItem rows.
+ *
+ * @module FieldServiceModule
+ * @entity EquipmentReturn
+ * @schemaId d74a5bd0-d153-4dfb-ad8a-6c3233a3e0ce
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_EQUIPMENT_RETURN_DEFAULT_DELETED = exports.ROUTING_KEY_EQUIPMENT_RETURN_DEFAULT_UPDATED = exports.ROUTING_KEY_EQUIPMENT_RETURN_DEFAULT_CREATED = exports.ROUTING_KEY_EQUIPMENT_RETURN_DELETED = exports.ROUTING_KEY_EQUIPMENT_RETURN_UPDATED = exports.ROUTING_KEY_EQUIPMENT_RETURN_CREATED = exports.EquipmentReturn = exports.EquipmentReturnPropertyKeys = exports.EquipmentReturnEntityTypes = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Available types for EquipmentReturn records
+ */
+var EquipmentReturnEntityTypes;
+(function (EquipmentReturnEntityTypes) {
+    /** This is the default record type */
+    EquipmentReturnEntityTypes["DEFAULT"] = "DEFAULT";
+})(EquipmentReturnEntityTypes = exports.EquipmentReturnEntityTypes || (exports.EquipmentReturnEntityTypes = {}));
+/**
+ * Property keys for EquipmentReturn
+ * Use these constants instead of string literals for type safety
+ */
+var EquipmentReturnPropertyKeys;
+(function (EquipmentReturnPropertyKeys) {
+})(EquipmentReturnPropertyKeys = exports.EquipmentReturnPropertyKeys || (exports.EquipmentReturnPropertyKeys = {}));
+/**
+ * EquipmentReturn entity from FieldServiceModule
+ *
+ * One warehouse inspection of one returned parcel, against the collection or replacement work order that asked for it back. Holds the inspector, the notes and the verdict; the devices themselves are EquipmentReturnItem rows.
+ *
+ * @module FieldServiceModule
+ * @entity EquipmentReturn
+ * @schemaId d74a5bd0-d153-4dfb-ad8a-6c3233a3e0ce
+ * @recordPrefix EQR
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+class EquipmentReturn extends core_1.OdinRecord {
+}
+exports.EquipmentReturn = EquipmentReturn;
+// ============================================
+// RABBITMQ EVENT ROUTING KEYS
+// ============================================
+/**
+ * RabbitMQ routing keys for EquipmentReturn events
+ */
+exports.ROUTING_KEY_EQUIPMENT_RETURN_CREATED = 'FieldServiceModule.EquipmentReturn.SubDbRecordCreated';
+exports.ROUTING_KEY_EQUIPMENT_RETURN_UPDATED = 'FieldServiceModule.EquipmentReturn.SubDbRecordUpdated';
+exports.ROUTING_KEY_EQUIPMENT_RETURN_DELETED = 'FieldServiceModule.EquipmentReturn.SubDbRecordDeleted';
+/**
+ * Type-specific routing keys for EquipmentReturn events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+exports.ROUTING_KEY_EQUIPMENT_RETURN_DEFAULT_CREATED = 'FieldServiceModule.EquipmentReturn.DEFAULT.SubDbRecordCreated';
+/** This is the default record type updated */
+exports.ROUTING_KEY_EQUIPMENT_RETURN_DEFAULT_UPDATED = 'FieldServiceModule.EquipmentReturn.DEFAULT.SubDbRecordUpdated';
+/** This is the default record type deleted */
+exports.ROUTING_KEY_EQUIPMENT_RETURN_DEFAULT_DELETED = 'FieldServiceModule.EquipmentReturn.DEFAULT.SubDbRecordDeleted';

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

@@ -0,0 +1,66 @@
+/**
+ * EquipmentReturnItem Entity Definition
+ *
+ * One device on one EquipmentReturn: whether it came back and what grade it was given. Links to the device record, so no serial matching and no five-slot cap. A row is written for a device that did not come back too.
+ *
+ * @module FieldServiceModule
+ * @entity EquipmentReturnItem
+ * @schemaId bb475f2a-2770-452c-b8d9-09d2d4b7a8b1
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+import { OdinRecord } from '@d19n/odin-types/dist/core';
+/**
+ * Available types for EquipmentReturnItem records
+ */
+export declare enum EquipmentReturnItemEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * Property keys for EquipmentReturnItem
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum EquipmentReturnItemPropertyKeys {
+}
+/**
+ * Properties for EquipmentReturnItem records
+ *
+ * @see FieldServiceModule:EquipmentReturnItem
+ */
+export interface EquipmentReturnItemProperties {
+}
+/**
+ * EquipmentReturnItem entity from FieldServiceModule
+ *
+ * One device on one EquipmentReturn: whether it came back and what grade it was given. Links to the device record, so no serial matching and no five-slot cap. A row is written for a device that did not come back too.
+ *
+ * @module FieldServiceModule
+ * @entity EquipmentReturnItem
+ * @schemaId bb475f2a-2770-452c-b8d9-09d2d4b7a8b1
+ * @recordPrefix EQRI
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+export declare class EquipmentReturnItem extends OdinRecord<EquipmentReturnItemProperties> {
+    entity: 'FieldServiceModule:EquipmentReturnItem';
+    type: EquipmentReturnItemEntityTypes;
+    schemaId: 'bb475f2a-2770-452c-b8d9-09d2d4b7a8b1';
+    properties: EquipmentReturnItemProperties;
+}
+/**
+ * RabbitMQ routing keys for EquipmentReturnItem events
+ */
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_ITEM_CREATED = "FieldServiceModule.EquipmentReturnItem.SubDbRecordCreated";
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_ITEM_UPDATED = "FieldServiceModule.EquipmentReturnItem.SubDbRecordUpdated";
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DELETED = "FieldServiceModule.EquipmentReturnItem.SubDbRecordDeleted";
+/**
+ * Type-specific routing keys for EquipmentReturnItem events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DEFAULT_CREATED = "FieldServiceModule.EquipmentReturnItem.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DEFAULT_UPDATED = "FieldServiceModule.EquipmentReturnItem.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DEFAULT_DELETED = "FieldServiceModule.EquipmentReturnItem.DEFAULT.SubDbRecordDeleted";

package/dist/entities-v2/EquipmentReturnItem.js

@@ -0,0 +1,64 @@
+"use strict";
+/**
+ * EquipmentReturnItem Entity Definition
+ *
+ * One device on one EquipmentReturn: whether it came back and what grade it was given. Links to the device record, so no serial matching and no five-slot cap. A row is written for a device that did not come back too.
+ *
+ * @module FieldServiceModule
+ * @entity EquipmentReturnItem
+ * @schemaId bb475f2a-2770-452c-b8d9-09d2d4b7a8b1
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DEFAULT_DELETED = exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DEFAULT_UPDATED = exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DEFAULT_CREATED = exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DELETED = exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_UPDATED = exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_CREATED = exports.EquipmentReturnItem = exports.EquipmentReturnItemPropertyKeys = exports.EquipmentReturnItemEntityTypes = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Available types for EquipmentReturnItem records
+ */
+var EquipmentReturnItemEntityTypes;
+(function (EquipmentReturnItemEntityTypes) {
+    /** This is the default record type */
+    EquipmentReturnItemEntityTypes["DEFAULT"] = "DEFAULT";
+})(EquipmentReturnItemEntityTypes = exports.EquipmentReturnItemEntityTypes || (exports.EquipmentReturnItemEntityTypes = {}));
+/**
+ * Property keys for EquipmentReturnItem
+ * Use these constants instead of string literals for type safety
+ */
+var EquipmentReturnItemPropertyKeys;
+(function (EquipmentReturnItemPropertyKeys) {
+})(EquipmentReturnItemPropertyKeys = exports.EquipmentReturnItemPropertyKeys || (exports.EquipmentReturnItemPropertyKeys = {}));
+/**
+ * EquipmentReturnItem entity from FieldServiceModule
+ *
+ * One device on one EquipmentReturn: whether it came back and what grade it was given. Links to the device record, so no serial matching and no five-slot cap. A row is written for a device that did not come back too.
+ *
+ * @module FieldServiceModule
+ * @entity EquipmentReturnItem
+ * @schemaId bb475f2a-2770-452c-b8d9-09d2d4b7a8b1
+ * @recordPrefix EQRI
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+class EquipmentReturnItem extends core_1.OdinRecord {
+}
+exports.EquipmentReturnItem = EquipmentReturnItem;
+// ============================================
+// RABBITMQ EVENT ROUTING KEYS
+// ============================================
+/**
+ * RabbitMQ routing keys for EquipmentReturnItem events
+ */
+exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_CREATED = 'FieldServiceModule.EquipmentReturnItem.SubDbRecordCreated';
+exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_UPDATED = 'FieldServiceModule.EquipmentReturnItem.SubDbRecordUpdated';
+exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DELETED = 'FieldServiceModule.EquipmentReturnItem.SubDbRecordDeleted';
+/**
+ * Type-specific routing keys for EquipmentReturnItem events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DEFAULT_CREATED = 'FieldServiceModule.EquipmentReturnItem.DEFAULT.SubDbRecordCreated';
+/** This is the default record type updated */
+exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DEFAULT_UPDATED = 'FieldServiceModule.EquipmentReturnItem.DEFAULT.SubDbRecordUpdated';
+/** This is the default record type deleted */
+exports.ROUTING_KEY_EQUIPMENT_RETURN_ITEM_DEFAULT_DELETED = 'FieldServiceModule.EquipmentReturnItem.DEFAULT.SubDbRecordDeleted';

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

@@ -74,6 +74,8 @@ import { UgInProgressAuditProperties } from './UgInProgressAudit';
 import { PgDirectDebitFileProperties } from './PgDirectDebitFile';
 import { YfWifiSurveyProperties } from './YfWifiSurvey';
 import { YfFieldVisitOutcomeFormProperties } from './YfFieldVisitOutcomeForm';
+import { DocumentProperties } from './Document';
+import { DocumentProcessingProperties } from './DocumentProcessing';
 /**
  * Available types for File records
  */
@@ -97,7 +99,9 @@ export declare enum FileEntityTypes {
     /** Openreach A55 */
     OPENREACH_A55 = "OPENREACH_A55",
     /** OTDR evidence for L1 and L2 closures */
-    OTDR = "OTDR"
+    OTDR = "OTDR",
+    /** JSON detail of a document pipeline run, linked to its AiModule:DocumentProcessing row (e.g. per-question verdicts and reasons). */
+    PROCESSING_OUTPUT = "PROCESSING_OUTPUT"
 }
 /**
  * Valid values for File.DataStore
@@ -822,6 +826,72 @@ export interface OtdrFileProperties {
      */
     MetaData: string;
 }
+/**
+ * Properties for PROCESSING_OUTPUT File records
+ *
+ * @see SchemaModule:File
+ */
+export interface ProcessingOutputFileProperties {
+    /** the storage provider (Platform - File)
+     *
+     * @type {ENUM}
+     * @default AWS_S3
+     * @enum {FileDataStore}
+     */
+    DataStore: FileDataStore;
+    /** the full url for the object in an S3 bucket (Platform - File)
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Url: string;
+    /** the object key for aws S3 (Platform - File)
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Key: string;
+    /** the bucket for aws S3 (Platform - File)
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Bucket: string;
+    /** the mimetype for the file (Platform - File)
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Mimetype: string;
+    /** longitude and latitude coordinates (Platform - File)
+     *
+     * @type {TEXT}
+     */
+    Coordinates: string;
+    /** Image source - type of device (Platform - File)
+     *
+     * @type {ENUM}
+     * @enum {FileDevice}
+     * @hidden This field is hidden in the UI
+     */
+    Device: FileDevice;
+    /** the category this file belongs to (Platform - File)
+     *
+     * @type {ENUM}
+     * @enum {FileCategory}
+     */
+    Category: FileCategory;
+    /** the unique hash for the file (Platform - File)
+     *
+     * @type {TEXT}
+     */
+    HashId: string;
+    /** metadata can store any JSON content (Platform - File)
+     *
+     * @type {JSON}
+     */
+    MetaData: string;
+}
 /**
  * File entity from SchemaModule
  *
@@ -964,6 +1034,10 @@ export declare class File extends OdinRecord<FileProperties> {
     YfWifiSurvey: OdinLink<LinkedOdinRecord<YfWifiSurveyProperties>>;
     /** Linked YfFieldVisitOutcomeForm records (YfFieldVisitOutcomeForm__File) */
     YfFieldVisitOutcomeForm: OdinLink<LinkedOdinRecord<YfFieldVisitOutcomeFormProperties>>;
+    /** Linked Document records (Document__File) */
+    Document: OdinLink<LinkedOdinRecord<DocumentProperties>>;
+    /** Linked DocumentProcessing records (DocumentProcessing__File) */
+    DocumentProcessing: OdinLink<LinkedOdinRecord<DocumentProcessingProperties>>;
 }
 /**
  * RabbitMQ routing keys for File events
@@ -1035,6 +1109,12 @@ export declare const ROUTING_KEY_FILE_OTDR_CREATED = "SchemaModule.File.OTDR.Sub
 export declare const ROUTING_KEY_FILE_OTDR_UPDATED = "SchemaModule.File.OTDR.SubDbRecordUpdated";
 /** OTDR evidence for L1 and L2 closures deleted */
 export declare const ROUTING_KEY_FILE_OTDR_DELETED = "SchemaModule.File.OTDR.SubDbRecordDeleted";
+/** JSON detail of a document pipeline run, linked to its AiModule:DocumentProcessing row (e.g. per-question verdicts and reasons). created */
+export declare const ROUTING_KEY_FILE_PROCESSING_OUTPUT_CREATED = "SchemaModule.File.PROCESSING_OUTPUT.SubDbRecordCreated";
+/** JSON detail of a document pipeline run, linked to its AiModule:DocumentProcessing row (e.g. per-question verdicts and reasons). updated */
+export declare const ROUTING_KEY_FILE_PROCESSING_OUTPUT_UPDATED = "SchemaModule.File.PROCESSING_OUTPUT.SubDbRecordUpdated";
+/** JSON detail of a document pipeline run, linked to its AiModule:DocumentProcessing row (e.g. per-question verdicts and reasons). deleted */
+export declare const ROUTING_KEY_FILE_PROCESSING_OUTPUT_DELETED = "SchemaModule.File.PROCESSING_OUTPUT.SubDbRecordDeleted";
 /** Event: File__Note link created */
 export declare const ROUTING_KEY_LINK_FILE_NOTE_CREATED = "SchemaModule.File.Note.SubDbRecordAssociationCreated";
 /** Event: File__Note link deleted */

package/dist/entities-v2/File.js

@@ -12,7 +12,7 @@
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_FILE_NOTE_DELETED = exports.ROUTING_KEY_LINK_FILE_NOTE_CREATED = exports.ROUTING_KEY_FILE_OTDR_DELETED = exports.ROUTING_KEY_FILE_OTDR_UPDATED = exports.ROUTING_KEY_FILE_OTDR_CREATED = exports.ROUTING_KEY_FILE_OPENREACH_A55_DELETED = exports.ROUTING_KEY_FILE_OPENREACH_A55_UPDATED = exports.ROUTING_KEY_FILE_OPENREACH_A55_CREATED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_DELETED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_UPDATED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_CREATED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_DELETED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_UPDATED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_CREATED = exports.ROUTING_KEY_FILE_INVOICE_DELETED = exports.ROUTING_KEY_FILE_INVOICE_UPDATED = exports.ROUTING_KEY_FILE_INVOICE_CREATED = exports.ROUTING_KEY_FILE_EMAIL_DELETED = exports.ROUTING_KEY_FILE_EMAIL_UPDATED = exports.ROUTING_KEY_FILE_EMAIL_CREATED = exports.ROUTING_KEY_FILE_DEFAULT_DELETED = exports.ROUTING_KEY_FILE_DEFAULT_UPDATED = exports.ROUTING_KEY_FILE_DEFAULT_CREATED = exports.ROUTING_KEY_FILE_CSV_DELETED = exports.ROUTING_KEY_FILE_CSV_UPDATED = exports.ROUTING_KEY_FILE_CSV_CREATED = exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_DELETED = exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_UPDATED = exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_CREATED = exports.ROUTING_KEY_FILE_AFP_INVOICE_DELETED = exports.ROUTING_KEY_FILE_AFP_INVOICE_UPDATED = exports.ROUTING_KEY_FILE_AFP_INVOICE_CREATED = exports.ROUTING_KEY_FILE_DELETED = exports.ROUTING_KEY_FILE_UPDATED = exports.ROUTING_KEY_FILE_CREATED = exports.File = exports.FilePropertyKeys = exports.FileCategory = exports.FileDevice = exports.FileDataStore = exports.FileEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_FILE_NOTE_DELETED = exports.ROUTING_KEY_LINK_FILE_NOTE_CREATED = exports.ROUTING_KEY_FILE_PROCESSING_OUTPUT_DELETED = exports.ROUTING_KEY_FILE_PROCESSING_OUTPUT_UPDATED = exports.ROUTING_KEY_FILE_PROCESSING_OUTPUT_CREATED = exports.ROUTING_KEY_FILE_OTDR_DELETED = exports.ROUTING_KEY_FILE_OTDR_UPDATED = exports.ROUTING_KEY_FILE_OTDR_CREATED = exports.ROUTING_KEY_FILE_OPENREACH_A55_DELETED = exports.ROUTING_KEY_FILE_OPENREACH_A55_UPDATED = exports.ROUTING_KEY_FILE_OPENREACH_A55_CREATED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_DELETED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_UPDATED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_CREATED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_DELETED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_UPDATED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_CREATED = exports.ROUTING_KEY_FILE_INVOICE_DELETED = exports.ROUTING_KEY_FILE_INVOICE_UPDATED = exports.ROUTING_KEY_FILE_INVOICE_CREATED = exports.ROUTING_KEY_FILE_EMAIL_DELETED = exports.ROUTING_KEY_FILE_EMAIL_UPDATED = exports.ROUTING_KEY_FILE_EMAIL_CREATED = exports.ROUTING_KEY_FILE_DEFAULT_DELETED = exports.ROUTING_KEY_FILE_DEFAULT_UPDATED = exports.ROUTING_KEY_FILE_DEFAULT_CREATED = exports.ROUTING_KEY_FILE_CSV_DELETED = exports.ROUTING_KEY_FILE_CSV_UPDATED = exports.ROUTING_KEY_FILE_CSV_CREATED = exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_DELETED = exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_UPDATED = exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_CREATED = exports.ROUTING_KEY_FILE_AFP_INVOICE_DELETED = exports.ROUTING_KEY_FILE_AFP_INVOICE_UPDATED = exports.ROUTING_KEY_FILE_AFP_INVOICE_CREATED = exports.ROUTING_KEY_FILE_DELETED = exports.ROUTING_KEY_FILE_UPDATED = exports.ROUTING_KEY_FILE_CREATED = exports.File = exports.FilePropertyKeys = exports.FileCategory = exports.FileDevice = exports.FileDataStore = exports.FileEntityTypes = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for File records
@@ -39,6 +39,8 @@ var FileEntityTypes;
     FileEntityTypes["OPENREACH_A55"] = "OPENREACH_A55";
     /** OTDR evidence for L1 and L2 closures */
     FileEntityTypes["OTDR"] = "OTDR";
+    /** JSON detail of a document pipeline run, linked to its AiModule:DocumentProcessing row (e.g. per-question verdicts and reasons). */
+    FileEntityTypes["PROCESSING_OUTPUT"] = "PROCESSING_OUTPUT";
 })(FileEntityTypes = exports.FileEntityTypes || (exports.FileEntityTypes = {}));
 /**
  * Valid values for File.DataStore
@@ -194,6 +196,12 @@ exports.ROUTING_KEY_FILE_OTDR_CREATED = 'SchemaModule.File.OTDR.SubDbRecordCreat
 exports.ROUTING_KEY_FILE_OTDR_UPDATED = 'SchemaModule.File.OTDR.SubDbRecordUpdated';
 /** OTDR evidence for L1 and L2 closures deleted */
 exports.ROUTING_KEY_FILE_OTDR_DELETED = 'SchemaModule.File.OTDR.SubDbRecordDeleted';
+/** JSON detail of a document pipeline run, linked to its AiModule:DocumentProcessing row (e.g. per-question verdicts and reasons). created */
+exports.ROUTING_KEY_FILE_PROCESSING_OUTPUT_CREATED = 'SchemaModule.File.PROCESSING_OUTPUT.SubDbRecordCreated';
+/** JSON detail of a document pipeline run, linked to its AiModule:DocumentProcessing row (e.g. per-question verdicts and reasons). updated */
+exports.ROUTING_KEY_FILE_PROCESSING_OUTPUT_UPDATED = 'SchemaModule.File.PROCESSING_OUTPUT.SubDbRecordUpdated';
+/** JSON detail of a document pipeline run, linked to its AiModule:DocumentProcessing row (e.g. per-question verdicts and reasons). deleted */
+exports.ROUTING_KEY_FILE_PROCESSING_OUTPUT_DELETED = 'SchemaModule.File.PROCESSING_OUTPUT.SubDbRecordDeleted';
 /** Event: File__Note link created */
 exports.ROUTING_KEY_LINK_FILE_NOTE_CREATED = 'SchemaModule.File.Note.SubDbRecordAssociationCreated';
 /** Event: File__Note link deleted */

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

@@ -64,7 +64,9 @@ export declare enum MessagePropertyKeys {
     /** Who receive the message (if needed) (Communications - Message) */
     To = "To",
     /** Who sent the message (Communications - Message) */
-    From = "From"
+    From = "From",
+    /** Has the customer read this message in the app? Set to false when an agent or system message is written to an in-app chat, and to true when the app reports it read (PORTAPP-3306). Messages written before this column existed have no value, and no value counts as read — only an explicit false raises the unread badge. */
+    IsReadByCustomer = "IsReadByCustomer"
 }
 /**
  * Properties for Message records
@@ -118,6 +120,12 @@ export interface MessageProperties {
      * @type {TEXT}
      */
     From: string;
+    /** Has the customer read this message in the app? Set to false when an agent or system message is written to an in-app chat, and to true when the app reports it read (PORTAPP-3306). Messages written before this column existed have no value, and no value counts as read — only an explicit false raises the unread badge.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsReadByCustomer: boolean;
 }
 /**
  * Properties for CLOSE Message records
@@ -171,6 +179,12 @@ export interface CloseMessageProperties {
      * @type {TEXT}
      */
     From: string;
+    /** Has the customer read this message in the app? Set to false when an agent or system message is written to an in-app chat, and to true when the app reports it read (PORTAPP-3306). Messages written before this column existed have no value, and no value counts as read — only an explicit false raises the unread badge.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsReadByCustomer: boolean;
 }
 /**
  * Properties for EVENT Message records
@@ -224,6 +238,12 @@ export interface EventMessageProperties {
      * @type {TEXT}
      */
     From: string;
+    /** Has the customer read this message in the app? Set to false when an agent or system message is written to an in-app chat, and to true when the app reports it read (PORTAPP-3306). Messages written before this column existed have no value, and no value counts as read — only an explicit false raises the unread badge.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsReadByCustomer: boolean;
 }
 /**
  * Properties for NUDGE Message records
@@ -277,6 +297,12 @@ export interface NudgeMessageProperties {
      * @type {TEXT}
      */
     From: string;
+    /** Has the customer read this message in the app? Set to false when an agent or system message is written to an in-app chat, and to true when the app reports it read (PORTAPP-3306). Messages written before this column existed have no value, and no value counts as read — only an explicit false raises the unread badge.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsReadByCustomer: boolean;
 }
 /**
  * Message entity from NotificationModule

package/dist/entities-v2/Message.js

@@ -68,6 +68,8 @@ var MessagePropertyKeys;
     MessagePropertyKeys["To"] = "To";
     /** Who sent the message (Communications - Message) */
     MessagePropertyKeys["From"] = "From";
+    /** Has the customer read this message in the app? Set to false when an agent or system message is written to an in-app chat, and to true when the app reports it read (PORTAPP-3306). Messages written before this column existed have no value, and no value counts as read — only an explicit false raises the unread badge. */
+    MessagePropertyKeys["IsReadByCustomer"] = "IsReadByCustomer";
 })(MessagePropertyKeys = exports.MessagePropertyKeys || (exports.MessagePropertyKeys = {}));
 /**
  * Message entity from NotificationModule

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

@@ -51,6 +51,7 @@ import { RecontractProperties } from './Recontract';
 import { DataIssueProperties } from './DataIssue';
 import { WorkOrderProperties } from './WorkOrder';
 import { EmailProperties } from './Email';
+import { CommitmentProperties } from './Commitment';
 /**
  * Available types for Order records
  */
@@ -377,6 +378,19 @@ export declare enum OrderBatteryBackupAnswersSource {
     CUSTOMER_APP = "CUSTOMER_APP",
     CUSTOMER_PORTAL = "CUSTOMER_PORTAL"
 }
+/**
+ * Valid values for Order.FulfillmentState
+ *
+ * Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
+ *
+ * @remarks Available options:
+ * - `OPEN` - Open
+ * - `SETTLED` - Settled
+ */
+export declare enum OrderFulfillmentState {
+    OPEN = "OPEN",
+    SETTLED = "SETTLED"
+}
 /**
  * Property keys for Order
  * Use these constants instead of string literals for type safety
@@ -562,8 +576,6 @@ export declare enum OrderPropertyKeys {
     CashbackApprovalDate = "CashbackApprovalDate",
     /** Supplier-committed fulfillment date carried on COMMITTED KCI (per yf-kci-effect-bridge.ts#provide-committed). Stamped onto YF Order via walker-driven receiveKci PROPERTY_WRITE. */
     CommittedDate = "CommittedDate",
-    /** Used when restarting an existing service, allows the customer to specify what date is used for the RequestedCompletionDate on the supplier-side START order. Used for when a customer is technically able to start receiving service. */
-    RequestedActivationDate = "RequestedActivationDate",
     /** Whether a customer already has a battery pack from YouFibre or not */
     BatteryPackProvided = "BatteryPackProvided",
     /** I have read and confirm receipt of the Contract Summary. I consent to the Privacy Policy and acknowledge receipt of the T&Cs. (Sales - Contact) */
@@ -593,7 +605,15 @@ export declare enum OrderPropertyKeys {
     /** Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276). */
     BatteryBackupAnswersSource = "BatteryBackupAnswersSource",
     /** The day this order was deactivated. Cleared when the order goes back to Active, and kept when it goes on to Cancelled. Empty means the order is not deactivated. Not to be confused with DeactivateOnDate, which is a scheduled instruction and is cleared once it is acted on. */
-    DeactivationDate = "DeactivationDate"
+    DeactivationDate = "DeactivationDate",
+    /** Used when restarting an existing service, allows the customer to specify what date is used for the RequestedCompletionDate on the supplier-side START order. Used for when a customer is technically able to start receiving service. */
+    RequestedActivationDate = "RequestedActivationDate",
+    /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle. */
+    FulfillmentState = "FulfillmentState",
+    /** How many commitments are Pending or Breached. Written only by the lifecycle. */
+    OpenCommitmentCount = "OpenCommitmentCount",
+    /** 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"
 }
 /**
  * Properties for Order records
@@ -1162,11 +1182,6 @@ export interface OrderProperties {
      * @type {DATE}
      */
     CommittedDate: string;
-    /** Used when restarting an existing service, allows the customer to specify what date is used for the RequestedCompletionDate on the supplier-side START order. Used for when a customer is technically able to start receiving service.
-     *
-     * @type {DATE}
-     */
-    RequestedActivationDate: string;
     /** Whether a customer already has a battery pack from YouFibre or not
      *
      * @type {BOOLEAN}
@@ -1257,6 +1272,30 @@ export interface OrderProperties {
      * @default
      */
     DeactivationDate: string;
+    /** Used when restarting an existing service, allows the customer to specify what date is used for the RequestedCompletionDate on the supplier-side START order. Used for when a customer is technically able to start receiving service.
+     *
+     * @type {DATE}
+     */
+    RequestedActivationDate: string;
+    /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {OrderFulfillmentState}
+     */
+    FulfillmentState: OrderFulfillmentState;
+    /** How many commitments are Pending or Breached. Written only by the lifecycle.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    OpenCommitmentCount: number;
+    /** 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.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    EarliestDueAt: string;
 }
 /**
  * Order entity from OrderModule
@@ -1357,6 +1396,8 @@ export declare class Order extends OdinRecord<OrderProperties> {
     WorkOrder: OdinLink<LinkedOdinRecord<WorkOrderProperties>>;
     /** Linked Email records (Order__Email) */
     Email: OdinLink<LinkedOdinRecord<EmailProperties>>;
+    /** Linked Commitment records (Commitment__Order) */
+    Commitment: OdinLink<LinkedOdinRecord<CommitmentProperties>>;
 }
 /**
  * RabbitMQ routing keys for Order events