@d19n/youfibre-odin-sdk 2.0.376 → 2.0.378

package/dist/entities-v2/Case.js

@@ -422,6 +422,7 @@ var CaseCategory;
  * - `AMEND_MY_ORDER` - Amend my Order
  * - `AREA_AVAILABILITY_QUERY` - Area Availability Query
  * - `BAD_CSAT` - Bad CSAT
+ * - `BILLING` - Billing
  * - `CANCEL_APPOINTMENT` - Cancel Appointment
  * - `CHANGE_CONTACT_DETAILS` - Change contact details
  * - `CHURN_REQUEST` - Churn Request
@@ -431,9 +432,8 @@ var CaseCategory;
  * - `COMPLAINT` - Complaint
  * - `CONTRACT_BUYOUT` - Contract Buyout
  * - `COPY_OF_INVOICE` - Copy of Invoice
- * - `CUSTOMER_DEVICE_ISSUE` - Customer Device Issue
- * - `DATA_SUBJECT_ACCESS_REQUEST` - Data Subject Access Request
- * - ... and 45 more
+ * - `CS_ESCALATIONS` - CS Escalations
+ * - ... and 51 more
  */
 var CaseSubCategory;
 (function (CaseSubCategory) {
@@ -441,6 +441,7 @@ var CaseSubCategory;
     CaseSubCategory["AMEND_MY_ORDER"] = "AMEND_MY_ORDER";
     CaseSubCategory["AREA_AVAILABILITY_QUERY"] = "AREA_AVAILABILITY_QUERY";
     CaseSubCategory["BAD_CSAT"] = "BAD_CSAT";
+    CaseSubCategory["BILLING"] = "BILLING";
     CaseSubCategory["CANCEL_APPOINTMENT"] = "CANCEL_APPOINTMENT";
     CaseSubCategory["CHANGE_CONTACT_DETAILS"] = "CHANGE_CONTACT_DETAILS";
     CaseSubCategory["CHURN_REQUEST"] = "CHURN_REQUEST";
@@ -450,6 +451,7 @@ var CaseSubCategory;
     CaseSubCategory["COMPLAINT"] = "COMPLAINT";
     CaseSubCategory["CONTRACT_BUYOUT"] = "CONTRACT_BUYOUT";
     CaseSubCategory["COPY_OF_INVOICE"] = "COPY_OF_INVOICE";
+    CaseSubCategory["CS_ESCALATIONS"] = "CS_ESCALATIONS";
     CaseSubCategory["CUSTOMER_DEVICE_ISSUE"] = "CUSTOMER_DEVICE_ISSUE";
     CaseSubCategory["DATA_SUBJECT_ACCESS_REQUEST"] = "DATA_SUBJECT_ACCESS_REQUEST";
     CaseSubCategory["DIRECT_DEBIT"] = "DIRECT_DEBIT";
@@ -457,8 +459,10 @@ var CaseSubCategory;
     CaseSubCategory["EQUIPMENT_RETURN_REFUND"] = "EQUIPMENT_RETURN_REFUND";
     CaseSubCategory["ESCALATED_COMPLAINT"] = "ESCALATED_COMPLAINT";
     CaseSubCategory["ETF_CUSTOMER_LEAVING_YF"] = "ETF_CUSTOMER_LEAVING";
+    CaseSubCategory["FORMAL_COMPLAINTS"] = "FORMAL_COMPLAINTS";
     CaseSubCategory["FRUSTRATION_OUTREACH"] = "FRUSTRATION_OUTREACH";
     CaseSubCategory["GDPR_DATA_BREACH"] = "GDPR_DATA_BREACH";
+    CaseSubCategory["HOME_MOVES"] = "HOME_MOVES";
     CaseSubCategory["INACTIVE_CHAT_NO_CUSTOMER_RESPONSE"] = "INACTIVE_CHAT_NO_CUSTOMER_RESPONSE";
     CaseSubCategory["INSTALL_APPOINTMENT"] = "INSTALL_APPOINTMENT";
     CaseSubCategory["INSTALL_REMEDIATION_QUERY"] = "INSTALL_REMEDIATION_QUERY";
@@ -488,6 +492,8 @@ var CaseSubCategory;
     CaseSubCategory["RECONTRACT_UPGRADE"] = "RECONTRACT_UPGRADE";
     CaseSubCategory["REFERRAL"] = "REFERRAL";
     CaseSubCategory["RETENTIONS"] = "RETENTIONS";
+    CaseSubCategory["SALES"] = "SALES";
+    CaseSubCategory["SALES_CBO"] = "SALES_CBO";
     CaseSubCategory["SERVICE_VISIT"] = "SERVICE_VISIT";
     CaseSubCategory["SPAM"] = "SPAM";
     CaseSubCategory["SPEED_HARD_WIRED"] = "SPEED_HARD_WIRED";

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

@@ -296,7 +296,7 @@ export declare enum ChangeReasonOwner {
  * - `ENGINEER_UNABLE_TO_RESOLVE` - Engineer unable to resolve
  * - `HEALTH_AND_SAFETY_CONCERN_CUSTOMER_PREMISE` - Health and safety concern - customer premise
  * - `INCORRECT_DATE_BOOKED` - Incorrect date booked
- * - ... and 14 more
+ * - ... and 15 more
  */
 export declare enum ChangeReasonRescheduleReason {
     ADDITIONAL_WORK_REQ_APPROVAL_NEEDED = "ADDITIONAL_WORKS_REQUIRED_APPROVAL_NEEDED",
@@ -322,6 +322,7 @@ export declare enum ChangeReasonRescheduleReason {
     SCHEDULE_CHANGED = "SCHEDULE_CHANGED",
     SCHEDULE_CONTRACTOR_CHANGED = "SCHEDULE_CONTRACTOR_CHANGED",
     SERVICE_VISIT_NO_LONGER_REQUIRED = "SERVICE_VISIT_NO_LONGER_REQUIRED",
+    START_ORDER_SERVICE_VISIT_RESCHEDULED = "START_ORDER_SERVICE_VISIT_RESCHEDULED",
     SUPPLIER_RESCHEDULED_APPOINTMENT = "SUPPLIER_RESCHEDULED_APPOINTMENT",
     TIME_BLOCK_CHANGED = "TIME_BLOCK_CHANGED",
     TLOS_PRIORITISED_NOT_ATTENDED = "TLOS_PRIORITISED_NOT_ATTENDED",

package/dist/entities-v2/ChangeReason.js

@@ -302,7 +302,7 @@ var ChangeReasonOwner;
  * - `ENGINEER_UNABLE_TO_RESOLVE` - Engineer unable to resolve
  * - `HEALTH_AND_SAFETY_CONCERN_CUSTOMER_PREMISE` - Health and safety concern - customer premise
  * - `INCORRECT_DATE_BOOKED` - Incorrect date booked
- * - ... and 14 more
+ * - ... and 15 more
  */
 var ChangeReasonRescheduleReason;
 (function (ChangeReasonRescheduleReason) {
@@ -329,6 +329,7 @@ var ChangeReasonRescheduleReason;
     ChangeReasonRescheduleReason["SCHEDULE_CHANGED"] = "SCHEDULE_CHANGED";
     ChangeReasonRescheduleReason["SCHEDULE_CONTRACTOR_CHANGED"] = "SCHEDULE_CONTRACTOR_CHANGED";
     ChangeReasonRescheduleReason["SERVICE_VISIT_NO_LONGER_REQUIRED"] = "SERVICE_VISIT_NO_LONGER_REQUIRED";
+    ChangeReasonRescheduleReason["START_ORDER_SERVICE_VISIT_RESCHEDULED"] = "START_ORDER_SERVICE_VISIT_RESCHEDULED";
     ChangeReasonRescheduleReason["SUPPLIER_RESCHEDULED_APPOINTMENT"] = "SUPPLIER_RESCHEDULED_APPOINTMENT";
     ChangeReasonRescheduleReason["TIME_BLOCK_CHANGED"] = "TIME_BLOCK_CHANGED";
     ChangeReasonRescheduleReason["TLOS_PRIORITISED_NOT_ATTENDED"] = "TLOS_PRIORITISED_NOT_ATTENDED";

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

@@ -14,6 +14,7 @@ import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/co
 import { FileProperties } from './File';
 import { DocumentProcessingProperties } from './DocumentProcessing';
 import { ContractBuyOutProperties } from './ContractBuyOut';
+import { DocumentValueProperties } from './DocumentValue';
 /**
  * Available types for Document records
  */
@@ -46,13 +47,15 @@ export declare enum DocumentEntityTypes {
  * - `HTML`
  * - `IMAGE` - Image
  * - `PDF`
+ * - `WORD` - Word
  */
 export declare enum DocumentFormat {
     EMAIL = "EMAIL",
     FORM_WITH_PHOTOS = "FORM_WITH_PHOTOS",
     HTML = "HTML",
     IMAGE = "IMAGE",
-    PDF = "PDF"
+    PDF = "PDF",
+    WORD = "WORD"
 }
 /**
  * Valid values for Document.SubmittedVia
@@ -82,6 +85,8 @@ export declare enum DocumentSubmittedVia {
  *
  * @remarks Available options:
  * - `CATALOGUED` - Catalogued
+ * - `CLASSIFIED` - Classified
+ * - `CLASSIFY_FAILED` - Classify failed
  * - `DELETED` - Deleted
  * - `DESCRIBED` - Described
  * - `DESCRIBE_FAILED` - Describe failed
@@ -95,6 +100,8 @@ export declare enum DocumentSubmittedVia {
  */
 export declare enum DocumentCatalogStatus {
     CATALOGUED = "CATALOGUED",
+    CLASSIFIED = "CLASSIFIED",
+    CLASSIFY_FAILED = "CLASSIFY_FAILED",
     DELETED = "DELETED",
     DESCRIBED = "DESCRIBED",
     DESCRIBE_FAILED = "DESCRIBE_FAILED",
@@ -191,7 +198,13 @@ export declare enum DocumentPropertyKeys {
     /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history. */
     FolderKey = "FolderKey",
     /** How many sections the read step produced; equals the number of vectors. */
-    SectionCount = "SectionCount"
+    SectionCount = "SectionCount",
+    /** The document type the model chose from the registry (CONTRACT, CORPORATE_DOCUMENT). The uploader's choice is the record type and is never changed by this. */
+    ClassifiedType = "ClassifiedType",
+    /** The sub-type the model chose from the registry (NDA, SUPPLY_AGREEMENT, ARTICLES_OF_ASSOCIATION, OTHER). The uploader's choice is SubType and is never changed by this. */
+    ClassifiedSubType = "ClassifiedSubType",
+    /** How sure the model was of its classification, 0 to 1. */
+    ClassificationConfidence = "ClassificationConfidence"
 }
 /**
  * Properties for Document records
@@ -401,6 +414,24 @@ export interface DocumentProperties {
      * @default
      */
     SectionCount: number;
+    /** The document type the model chose from the registry (CONTRACT, CORPORATE_DOCUMENT). The uploader's choice is the record type and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedType: string;
+    /** The sub-type the model chose from the registry (NDA, SUPPLY_AGREEMENT, ARTICLES_OF_ASSOCIATION, OTHER). The uploader's choice is SubType and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedSubType: string;
+    /** How sure the model was of its classification, 0 to 1.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ClassificationConfidence: number;
 }
 /**
  * Properties for CONTRACT Document records
@@ -610,6 +641,24 @@ export interface ContractDocumentProperties {
      * @default
      */
     SectionCount: number;
+    /** The document type the model chose from the registry (CONTRACT, CORPORATE_DOCUMENT). The uploader's choice is the record type and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedType: string;
+    /** The sub-type the model chose from the registry (NDA, SUPPLY_AGREEMENT, ARTICLES_OF_ASSOCIATION, OTHER). The uploader's choice is SubType and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedSubType: string;
+    /** How sure the model was of its classification, 0 to 1.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ClassificationConfidence: number;
 }
 /**
  * Properties for CONTRACT_BUYOUT Document records
@@ -819,6 +868,24 @@ export interface ContractBuyoutDocumentProperties {
      * @default
      */
     SectionCount: number;
+    /** The document type the model chose from the registry (CONTRACT, CORPORATE_DOCUMENT). The uploader's choice is the record type and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedType: string;
+    /** The sub-type the model chose from the registry (NDA, SUPPLY_AGREEMENT, ARTICLES_OF_ASSOCIATION, OTHER). The uploader's choice is SubType and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedSubType: string;
+    /** How sure the model was of its classification, 0 to 1.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ClassificationConfidence: number;
 }
 /**
  * Properties for CORPORATE_DOCUMENT Document records
@@ -1028,6 +1095,24 @@ export interface CorporateDocumentDocumentProperties {
      * @default
      */
     SectionCount: number;
+    /** The document type the model chose from the registry (CONTRACT, CORPORATE_DOCUMENT). The uploader's choice is the record type and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedType: string;
+    /** The sub-type the model chose from the registry (NDA, SUPPLY_AGREEMENT, ARTICLES_OF_ASSOCIATION, OTHER). The uploader's choice is SubType and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedSubType: string;
+    /** How sure the model was of its classification, 0 to 1.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ClassificationConfidence: number;
 }
 /**
  * Properties for EMAIL_ATTACHMENT Document records
@@ -1237,6 +1322,24 @@ export interface EmailAttachmentDocumentProperties {
      * @default
      */
     SectionCount: number;
+    /** The document type the model chose from the registry (CONTRACT, CORPORATE_DOCUMENT). The uploader's choice is the record type and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedType: string;
+    /** The sub-type the model chose from the registry (NDA, SUPPLY_AGREEMENT, ARTICLES_OF_ASSOCIATION, OTHER). The uploader's choice is SubType and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedSubType: string;
+    /** How sure the model was of its classification, 0 to 1.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ClassificationConfidence: number;
 }
 /**
  * Properties for INVOICE Document records
@@ -1446,6 +1549,24 @@ export interface InvoiceDocumentProperties {
      * @default
      */
     SectionCount: number;
+    /** The document type the model chose from the registry (CONTRACT, CORPORATE_DOCUMENT). The uploader's choice is the record type and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedType: string;
+    /** The sub-type the model chose from the registry (NDA, SUPPLY_AGREEMENT, ARTICLES_OF_ASSOCIATION, OTHER). The uploader's choice is SubType and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedSubType: string;
+    /** How sure the model was of its classification, 0 to 1.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ClassificationConfidence: number;
 }
 /**
  * Properties for OTHER Document records
@@ -1655,6 +1776,24 @@ export interface OtherDocumentProperties {
      * @default
      */
     SectionCount: number;
+    /** The document type the model chose from the registry (CONTRACT, CORPORATE_DOCUMENT). The uploader's choice is the record type and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedType: string;
+    /** The sub-type the model chose from the registry (NDA, SUPPLY_AGREEMENT, ARTICLES_OF_ASSOCIATION, OTHER). The uploader's choice is SubType and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedSubType: string;
+    /** How sure the model was of its classification, 0 to 1.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ClassificationConfidence: number;
 }
 /**
  * Properties for OUTCOME_FORM Document records
@@ -1864,6 +2003,24 @@ export interface OutcomeFormDocumentProperties {
      * @default
      */
     SectionCount: number;
+    /** The document type the model chose from the registry (CONTRACT, CORPORATE_DOCUMENT). The uploader's choice is the record type and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedType: string;
+    /** The sub-type the model chose from the registry (NDA, SUPPLY_AGREEMENT, ARTICLES_OF_ASSOCIATION, OTHER). The uploader's choice is SubType and is never changed by this.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ClassifiedSubType: string;
+    /** How sure the model was of its classification, 0 to 1.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ClassificationConfidence: number;
 }
 /**
  * Document entity from AiModule
@@ -1887,6 +2044,8 @@ export declare class Document extends OdinRecord<DocumentProperties> {
     DocumentProcessing: OdinLink<LinkedOdinRecord<DocumentProcessingProperties>>;
     /** Linked ContractBuyOut records (ContractBuyOut__Document) */
     ContractBuyOut: OdinLink<LinkedOdinRecord<ContractBuyOutProperties>>;
+    /** Linked DocumentValue records (Document__DocumentValue) */
+    DocumentValue: OdinLink<LinkedOdinRecord<DocumentValueProperties>>;
 }
 /**
  * RabbitMQ routing keys for Document events
@@ -1954,3 +2113,7 @@ export declare const ROUTING_KEY_LINK_DOCUMENT_FILE_DELETED = "AiModule.Document
 export declare const ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_CREATED = "AiModule.Document.DocumentProcessing.SubDbRecordAssociationCreated";
 /** Event: Document__DocumentProcessing link deleted */
 export declare const ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_DELETED = "AiModule.Document.DocumentProcessing.SubDbRecordAssociationDeleted";
+/** Event: Document__DocumentValue link created */
+export declare const ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_VALUE_CREATED = "AiModule.Document.DocumentValue.SubDbRecordAssociationCreated";
+/** Event: Document__DocumentValue link deleted */
+export declare const ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_VALUE_DELETED = "AiModule.Document.DocumentValue.SubDbRecordAssociationDeleted";

package/dist/entities-v2/Document.js

@@ -12,7 +12,7 @@
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_DELETED = exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_CREATED = exports.ROUTING_KEY_LINK_DOCUMENT_FILE_DELETED = exports.ROUTING_KEY_LINK_DOCUMENT_FILE_CREATED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_DELETED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_UPDATED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_CREATED = exports.ROUTING_KEY_DOCUMENT_OTHER_DELETED = exports.ROUTING_KEY_DOCUMENT_OTHER_UPDATED = exports.ROUTING_KEY_DOCUMENT_OTHER_CREATED = exports.ROUTING_KEY_DOCUMENT_INVOICE_DELETED = exports.ROUTING_KEY_DOCUMENT_INVOICE_UPDATED = exports.ROUTING_KEY_DOCUMENT_INVOICE_CREATED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_CREATED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_DELETED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_UPDATED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_CREATED = exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_CREATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_DELETED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_CREATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_DELETED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_CREATED = exports.ROUTING_KEY_DOCUMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CREATED = exports.Document = exports.DocumentPropertyKeys = exports.DocumentFieldsReviewState = exports.DocumentCatalogStatus = exports.DocumentSubmittedVia = exports.DocumentFormat = exports.DocumentEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_VALUE_DELETED = exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_VALUE_CREATED = exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_DELETED = exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_CREATED = exports.ROUTING_KEY_LINK_DOCUMENT_FILE_DELETED = exports.ROUTING_KEY_LINK_DOCUMENT_FILE_CREATED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_DELETED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_UPDATED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_CREATED = exports.ROUTING_KEY_DOCUMENT_OTHER_DELETED = exports.ROUTING_KEY_DOCUMENT_OTHER_UPDATED = exports.ROUTING_KEY_DOCUMENT_OTHER_CREATED = exports.ROUTING_KEY_DOCUMENT_INVOICE_DELETED = exports.ROUTING_KEY_DOCUMENT_INVOICE_UPDATED = exports.ROUTING_KEY_DOCUMENT_INVOICE_CREATED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_CREATED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_DELETED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_UPDATED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_CREATED = exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_CREATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_DELETED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_CREATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_DELETED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_CREATED = exports.ROUTING_KEY_DOCUMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CREATED = exports.Document = exports.DocumentPropertyKeys = exports.DocumentFieldsReviewState = exports.DocumentCatalogStatus = exports.DocumentSubmittedVia = exports.DocumentFormat = exports.DocumentEntityTypes = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for Document records
@@ -47,6 +47,7 @@ var DocumentEntityTypes;
  * - `HTML`
  * - `IMAGE` - Image
  * - `PDF`
+ * - `WORD` - Word
  */
 var DocumentFormat;
 (function (DocumentFormat) {
@@ -55,6 +56,7 @@ var DocumentFormat;
     DocumentFormat["HTML"] = "HTML";
     DocumentFormat["IMAGE"] = "IMAGE";
     DocumentFormat["PDF"] = "PDF";
+    DocumentFormat["WORD"] = "WORD";
 })(DocumentFormat = exports.DocumentFormat || (exports.DocumentFormat = {}));
 /**
  * Valid values for Document.SubmittedVia
@@ -85,6 +87,8 @@ var DocumentSubmittedVia;
  *
  * @remarks Available options:
  * - `CATALOGUED` - Catalogued
+ * - `CLASSIFIED` - Classified
+ * - `CLASSIFY_FAILED` - Classify failed
  * - `DELETED` - Deleted
  * - `DESCRIBED` - Described
  * - `DESCRIBE_FAILED` - Describe failed
@@ -99,6 +103,8 @@ var DocumentSubmittedVia;
 var DocumentCatalogStatus;
 (function (DocumentCatalogStatus) {
     DocumentCatalogStatus["CATALOGUED"] = "CATALOGUED";
+    DocumentCatalogStatus["CLASSIFIED"] = "CLASSIFIED";
+    DocumentCatalogStatus["CLASSIFY_FAILED"] = "CLASSIFY_FAILED";
     DocumentCatalogStatus["DELETED"] = "DELETED";
     DocumentCatalogStatus["DESCRIBED"] = "DESCRIBED";
     DocumentCatalogStatus["DESCRIBE_FAILED"] = "DESCRIBE_FAILED";
@@ -198,6 +204,12 @@ var DocumentPropertyKeys;
     DocumentPropertyKeys["FolderKey"] = "FolderKey";
     /** How many sections the read step produced; equals the number of vectors. */
     DocumentPropertyKeys["SectionCount"] = "SectionCount";
+    /** The document type the model chose from the registry (CONTRACT, CORPORATE_DOCUMENT). The uploader's choice is the record type and is never changed by this. */
+    DocumentPropertyKeys["ClassifiedType"] = "ClassifiedType";
+    /** The sub-type the model chose from the registry (NDA, SUPPLY_AGREEMENT, ARTICLES_OF_ASSOCIATION, OTHER). The uploader's choice is SubType and is never changed by this. */
+    DocumentPropertyKeys["ClassifiedSubType"] = "ClassifiedSubType";
+    /** How sure the model was of its classification, 0 to 1. */
+    DocumentPropertyKeys["ClassificationConfidence"] = "ClassificationConfidence";
 })(DocumentPropertyKeys = exports.DocumentPropertyKeys || (exports.DocumentPropertyKeys = {}));
 /**
  * Document entity from AiModule
@@ -282,3 +294,7 @@ exports.ROUTING_KEY_LINK_DOCUMENT_FILE_DELETED = 'AiModule.Document.File.SubDbRe
 exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_CREATED = 'AiModule.Document.DocumentProcessing.SubDbRecordAssociationCreated';
 /** Event: Document__DocumentProcessing link deleted */
 exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_DELETED = 'AiModule.Document.DocumentProcessing.SubDbRecordAssociationDeleted';
+/** Event: Document__DocumentValue link created */
+exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_VALUE_CREATED = 'AiModule.Document.DocumentValue.SubDbRecordAssociationCreated';
+/** Event: Document__DocumentValue link deleted */
+exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_VALUE_DELETED = 'AiModule.Document.DocumentValue.SubDbRecordAssociationDeleted';

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

@@ -28,6 +28,7 @@ export declare enum DocumentProcessingEntityTypes {
  * @remarks Available options:
  * - `CBO_FINAL_BILL_CHECK` - CBO final bill check
  * - `CHAT` - Chat
+ * - `CLASSIFY` - Classify
  * - `DESCRIBE` - Describe
  * - `EMBED` - Embed
  * - `EXTRACT_FIELDS` - Extract fields
@@ -38,6 +39,7 @@ export declare enum DocumentProcessingEntityTypes {
 export declare enum DocumentProcessingUseCase {
     CBO_FINAL_BILL_CHECK = "CBO_FINAL_BILL_CHECK",
     CHAT = "CHAT",
+    CLASSIFY = "CLASSIFY",
     DESCRIBE = "DESCRIBE",
     EMBED = "EMBED",
     EXTRACT_FIELDS = "EXTRACT_FIELDS",

package/dist/entities-v2/DocumentProcessing.js

@@ -30,6 +30,7 @@ var DocumentProcessingEntityTypes;
  * @remarks Available options:
  * - `CBO_FINAL_BILL_CHECK` - CBO final bill check
  * - `CHAT` - Chat
+ * - `CLASSIFY` - Classify
  * - `DESCRIBE` - Describe
  * - `EMBED` - Embed
  * - `EXTRACT_FIELDS` - Extract fields
@@ -41,6 +42,7 @@ var DocumentProcessingUseCase;
 (function (DocumentProcessingUseCase) {
     DocumentProcessingUseCase["CBO_FINAL_BILL_CHECK"] = "CBO_FINAL_BILL_CHECK";
     DocumentProcessingUseCase["CHAT"] = "CHAT";
+    DocumentProcessingUseCase["CLASSIFY"] = "CLASSIFY";
     DocumentProcessingUseCase["DESCRIBE"] = "DESCRIBE";
     DocumentProcessingUseCase["EMBED"] = "EMBED";
     DocumentProcessingUseCase["EXTRACT_FIELDS"] = "EXTRACT_FIELDS";

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

@@ -0,0 +1,213 @@
+/**
+ * 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
+ */
+import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
+import { DocumentProperties } from './Document';
+/**
+ * Available types for DocumentValue records
+ */
+export declare enum DocumentValueEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * 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
+ */
+export declare enum DocumentValueKind {
+    BOOLEAN = "BOOLEAN",
+    DATE = "DATE",
+    MONEY = "MONEY",
+    NUMBER = "NUMBER",
+    PARTY = "PARTY",
+    TEXT = "TEXT"
+}
+/**
+ * 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
+ */
+export declare enum DocumentValueReviewState {
+    CONFIRMED = "CONFIRMED",
+    CORRECTED = "CORRECTED",
+    NEEDS_REVIEW = "NEEDS_REVIEW",
+    NOT_FOUND = "NOT_FOUND"
+}
+/**
+ * Property keys for DocumentValue
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum DocumentValuePropertyKeys {
+    /** The field name from the field list for the document type, e.g. GoverningLaw, PaymentDays. */
+    Field = "Field",
+    /** The type of the value, from the field list. */
+    Kind = "Kind",
+    /** The value as text, after any correction. Blank when the document does not state it (see ReviewState NOT_FOUND). */
+    Value = "Value",
+    /** What the model extracted, kept beside a correction. Equal to Value until a person corrects it. */
+    ModelValue = "ModelValue",
+    /** The field list the value was extracted with, e.g. NDA. */
+    SchemaName = "SchemaName",
+    /** The version of that field list. */
+    SchemaVersion = "SchemaVersion",
+    /** How sure the model was, 0 to 1. */
+    Confidence = "Confidence",
+    /** The id of the section in sections.json the value was read from. */
+    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. */
+    Quote = "Quote",
+    /** The page of the section. */
+    Page = "Page",
+    /** Where the value stands with a person: needs review, confirmed, corrected, or not found in the document. */
+    ReviewState = "ReviewState",
+    /** The user who confirmed or corrected the value. */
+    ReviewedBy = "ReviewedBy",
+    /** When the value was confirmed or corrected. */
+    ReviewedAt = "ReviewedAt"
+}
+/**
+ * Properties for DocumentValue records
+ *
+ * @see AiModule:DocumentValue
+ */
+export interface DocumentValueProperties {
+    /** The field name from the field list for the document type, e.g. GoverningLaw, PaymentDays.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Field: string;
+    /** The type of the value, from the field list.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {DocumentValueKind}
+     */
+    Kind: DocumentValueKind;
+    /** The value as text, after any correction. Blank when the document does not state it (see ReviewState NOT_FOUND).
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Value: string;
+    /** What the model extracted, kept beside a correction. Equal to Value until a person corrects it.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ModelValue: string;
+    /** The field list the value was extracted with, e.g. NDA.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SchemaName: string;
+    /** The version of that field list.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    SchemaVersion: number;
+    /** How sure the model was, 0 to 1.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    Confidence: number;
+    /** The id of the section in sections.json the value was read from.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SectionId: string;
+    /** The passage, copied word for word from that section, the value rests on; checked against the stored text before the row is written.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    Quote: string;
+    /** The page of the section.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    Page: number;
+    /** Where the value stands with a person: needs review, confirmed, corrected, or not found in the document.
+     *
+     * @type {ENUM}
+     * @default NEEDS_REVIEW
+     * @enum {DocumentValueReviewState}
+     */
+    ReviewState: DocumentValueReviewState;
+    /** The user who confirmed or corrected the value.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ReviewedBy: string;
+    /** When the value was confirmed or corrected.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    ReviewedAt: string;
+}
+/**
+ * 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
+ */
+export declare class DocumentValue extends OdinRecord<DocumentValueProperties> {
+    entity: 'AiModule:DocumentValue';
+    type: DocumentValueEntityTypes;
+    schemaId: '96afdaae-fb15-4a46-bb1c-67ef9509e02d';
+    properties: DocumentValueProperties;
+    /** Linked Document records (Document__DocumentValue) */
+    Document: OdinLink<LinkedOdinRecord<DocumentProperties>>;
+}
+/**
+ * RabbitMQ routing keys for DocumentValue events
+ */
+export declare const ROUTING_KEY_DOCUMENT_VALUE_CREATED = "AiModule.DocumentValue.SubDbRecordCreated";
+export declare const ROUTING_KEY_DOCUMENT_VALUE_UPDATED = "AiModule.DocumentValue.SubDbRecordUpdated";
+export declare const 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 */
+export declare const ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_CREATED = "AiModule.DocumentValue.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_UPDATED = "AiModule.DocumentValue.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_DELETED = "AiModule.DocumentValue.DEFAULT.SubDbRecordDeleted";