@d19n/youfibre-odin-sdk 2.0.375 → 2.0.377

package/dist/db-sdk-v2/QaBatchSummaryDb.js

@@ -0,0 +1,204 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QaBatchSummaryDb = void 0;
+const db_provider_1 = require("@d19n/odin-sdk-generator/dist/db.provider");
+const db_record_link_manager_1 = require("@d19n/odin-sdk-generator/dist/db.record.link.manager");
+/**
+ * @deprecated Use OdinDbClient.
+ *
+ * Migration:
+ * - Old: new QaBatchSummaryApi(authParams).get(id)
+ * - New: new odin.qabatchsummary.get(id)
+ *
+ * The new OdinDbClient returns typed record wrappers with action methods.
+ *
+ * Supports separate query options and provider options:
+ * - Constructor level: new QaBatchSummaryDb(principal, dbService, { omitPermissionsCheck: true })
+ * - Method level: await db.getByPrimaryKey(id, { entities: [] }, { omitPermissionsCheck: true })
+ */
+class QaBatchSummaryDb extends db_provider_1.DbProvider {
+    constructor(principal, dbService, defaultOptions) {
+        super(principal, dbService, defaultOptions);
+        this.moduleName = 'SupportModule';
+        this.entityName = 'QaBatchSummary';
+        this.principal = principal;
+        this.dbService = dbService;
+        // Link managers are lazy-loaded on first access
+    }
+    // ============================================
+    // LAZY-LOADED LINK MANAGERS (Public Getters)
+    // ============================================
+    // Usage remains identical: db.address.list(recordId)
+    get qabatch() {
+        if (!this._qabatch) {
+            this._qabatch = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'SupportModule:QaBatchSummary', 'SupportModule:QaBatch', 'QaBatch__Summary');
+        }
+        return this._qabatch;
+    }
+    // ============================================
+    // STANDARD METHODS
+    // ============================================
+    // Methods support separate query options and provider options for clean API
+    setRecord(sourceRecord) {
+        this.sourceRecord = sourceRecord;
+    }
+    /**
+     * Search records with manual pagination control
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    searchRecords(params, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchRecords(this.moduleName, this.entityName, params, providerOptions);
+        });
+    }
+    /**
+     * Search all records with automatic pagination
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    searchAllRecordsAndPaginate(params, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchAllRecordsAndPaginate(this.moduleName, this.entityName, params, 0, providerOptions);
+        });
+    }
+    /**
+     * Get a single record by primary key
+     * @param qaBatchSummaryId - Record ID
+     * @param queryOptions - Query options (WHAT: entities to include)
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     *
+     * @example
+     * // Simple get
+     * const record = await db.getByPrimaryKey(id);
+     *
+     * // With related entities
+     * const record = await db.getByPrimaryKey(id, { entities: ['InvoiceItem', 'Transaction'] });
+     *
+     * // With permissions bypass
+     * const record = await db.getByPrimaryKey(id, {}, { omitPermissionsCheck: true });
+     *
+     * // Both options
+     * const record = await db.getByPrimaryKey(id, { entities: ['Invoice'] }, { omitPermissionsCheck: true });
+     */
+    getByPrimaryKey(qaBatchSummaryId, queryOptions, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._getByPrimaryKey(this.moduleName, this.entityName, qaBatchSummaryId, queryOptions, providerOptions);
+            if (res)
+                this.setRecord(res);
+            return res;
+        });
+    }
+    /**
+     * Get multiple records by primary keys
+     * @param qaBatchSummaryIds - Array of record IDs
+     * @param queryOptions - Query options (WHAT: entities to include)
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getManyByPrimaryKey(qaBatchSummaryIds, queryOptions, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getManyByPrimaryKey(this.moduleName, this.entityName, qaBatchSummaryIds, queryOptions, providerOptions);
+        });
+    }
+    /**
+     * Upsert a single record
+     * @param upsertDto - Record to upsert
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    upsert(upsertDto, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._upsert(this.moduleName, this.entityName, [upsertDto], providerOptions);
+            return res[0];
+        });
+    }
+    /**
+     * Upsert multiple records
+     * @param upsertDtos - Records to upsert
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    upsertMany(upsertDtos, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._upsert(this.moduleName, this.entityName, upsertDtos, providerOptions);
+        });
+    }
+    /**
+     * Update a single record
+     * @param updateDto - Record to update
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    update(updateDto, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._update(this.moduleName, this.entityName, [updateDto], providerOptions);
+            return res[0];
+        });
+    }
+    /**
+     * Update multiple records
+     * @param updateDtos - Records to update
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    updateMany(updateDtos, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._update(this.moduleName, this.entityName, updateDtos, providerOptions);
+        });
+    }
+    /**
+     * Delete one or many records
+     * @param qaBatchSummaryIds - Record IDs to delete
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    delete(qaBatchSummaryIds, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, qaBatchSummaryIds, providerOptions);
+        });
+    }
+    /**
+     * Restore one or many deleted records
+     * @param qaBatchSummaryIds - Record IDs to restore
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    restore(qaBatchSummaryIds, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._restore(this.moduleName, this.entityName, qaBatchSummaryIds, providerOptions);
+        });
+    }
+    /**
+     * Apply an action to a record
+     * @param actionName - The action key
+     * @param dto - The action DTO
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    applyAction(actionName, dto, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._applyAction(this.moduleName, this.entityName, dto, providerOptions);
+        });
+    }
+    /**
+     * Get version history for the current source record
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getVersions(providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getVersions(this.moduleName, this.entityName, this.sourceRecord.id, providerOptions);
+        });
+    }
+    /**
+     * Get revision timeline for the current source record
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getRevisionTimeline(providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getRevisionTimeline(this.moduleName, this.entityName, this.sourceRecord.id, providerOptions);
+        });
+    }
+}
+exports.QaBatchSummaryDb = QaBatchSummaryDb;

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

@@ -425,7 +425,9 @@ export declare enum ContactPropertyKeys {
     /** When AppBiometricLoginStatus last changed (PORTAPP-3345). */
     AppBiometricLoginStatusDate = "AppBiometricLoginStatusDate",
     /** Every platform the customer has used the app on. A platform is added when the app first reports it and is never removed. Empty until the app reports one (PORTAPP-3483). */
-    AppDevicePlatforms = "AppDevicePlatforms"
+    AppDevicePlatforms = "AppDevicePlatforms",
+    /** Timestamp of when this contact expressed interest in the TV product. Set by SetContactYouFibreTvInterest (CORE-1523), called from the customer-portal endpoint (PORTAPP-3551). */
+    YouFibreTvInterest = "YouFibreTvInterest"
 }
 /**
  * Properties for Contact records
@@ -828,6 +830,12 @@ export interface ContactProperties {
      * @hidden This field is hidden in the UI
      */
     AppDevicePlatforms: string;
+    /** Timestamp of when this contact expressed interest in the TV product. Set by SetContactYouFibreTvInterest (CORE-1523), called from the customer-portal endpoint (PORTAPP-3551).
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    YouFibreTvInterest: string;
 }
 /**
  * Contact entity from CrmModule

package/dist/entities-v2/Contact.js

@@ -411,6 +411,8 @@ var ContactPropertyKeys;
     ContactPropertyKeys["AppBiometricLoginStatusDate"] = "AppBiometricLoginStatusDate";
     /** Every platform the customer has used the app on. A platform is added when the app first reports it and is never removed. Empty until the app reports one (PORTAPP-3483). */
     ContactPropertyKeys["AppDevicePlatforms"] = "AppDevicePlatforms";
+    /** Timestamp of when this contact expressed interest in the TV product. Set by SetContactYouFibreTvInterest (CORE-1523), called from the customer-portal endpoint (PORTAPP-3551). */
+    ContactPropertyKeys["YouFibreTvInterest"] = "YouFibreTvInterest";
 })(ContactPropertyKeys = exports.ContactPropertyKeys || (exports.ContactPropertyKeys = {}));
 /**
  * Contact entity from CrmModule

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
@@ -90,10 +95,13 @@ export declare enum DocumentSubmittedVia {
  * - `EMBED_FAILED` - Embed failed
  * - `READ` - Read
  * - `READ_FAILED` - Read failed
+ * - `READ_PENDING` - Read pending
  * - `READY` - Ready
  */
 export declare enum DocumentCatalogStatus {
     CATALOGUED = "CATALOGUED",
+    CLASSIFIED = "CLASSIFIED",
+    CLASSIFY_FAILED = "CLASSIFY_FAILED",
     DELETED = "DELETED",
     DESCRIBED = "DESCRIBED",
     DESCRIBE_FAILED = "DESCRIBE_FAILED",
@@ -102,6 +110,7 @@ export declare enum DocumentCatalogStatus {
     EMBED_FAILED = "EMBED_FAILED",
     READ = "READ",
     READ_FAILED = "READ_FAILED",
+    READ_PENDING = "READ_PENDING",
     READY = "READY"
 }
 /**
@@ -189,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
@@ -399,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
@@ -608,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
@@ -817,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
@@ -1026,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
@@ -1235,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
@@ -1444,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
@@ -1653,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
@@ -1862,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
@@ -1885,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
@@ -1952,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
@@ -93,11 +97,14 @@ var DocumentSubmittedVia;
  * - `EMBED_FAILED` - Embed failed
  * - `READ` - Read
  * - `READ_FAILED` - Read failed
+ * - `READ_PENDING` - Read pending
  * - `READY` - Ready
  */
 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";
@@ -106,6 +113,7 @@ var DocumentCatalogStatus;
     DocumentCatalogStatus["EMBED_FAILED"] = "EMBED_FAILED";
     DocumentCatalogStatus["READ"] = "READ";
     DocumentCatalogStatus["READ_FAILED"] = "READ_FAILED";
+    DocumentCatalogStatus["READ_PENDING"] = "READ_PENDING";
     DocumentCatalogStatus["READY"] = "READY";
 })(DocumentCatalogStatus = exports.DocumentCatalogStatus || (exports.DocumentCatalogStatus = {}));
 /**
@@ -196,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
@@ -280,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";