@d19n/youfibre-odin-sdk 2.0.371 → 2.0.372

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

@@ -18,8 +18,12 @@ import { ContractBuyOutProperties } from './ContractBuyOut';
  * Available types for Document records
  */
 export declare enum DocumentEntityTypes {
+    /** An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind. */
+    CONTRACT = "CONTRACT",
     /** A customer's previous-provider final bill sent for a contract buyout (YouFibre orders). */
     CONTRACT_BUYOUT = "CONTRACT_BUYOUT",
+    /** A document about the company itself: articles of association, resolutions, filings. SubType says which kind. */
+    CORPORATE_DOCUMENT = "CORPORATE_DOCUMENT",
     /** This is the default record type */
     DEFAULT = "DEFAULT",
     /** A file attached to an inbound or outbound email. */
@@ -78,15 +82,42 @@ export declare enum DocumentSubmittedVia {
  *
  * @remarks Available options:
  * - `CATALOGUED` - Catalogued
+ * - `DELETED` - Deleted
  * - `DESCRIBED` - Described
  * - `DESCRIBE_FAILED` - Describe failed
  * - `DESCRIBE_PENDING` - Describe pending
+ * - `EMBEDDED` - Embedded
+ * - `EMBED_FAILED` - Embed failed
+ * - `READ` - Read
+ * - `READ_FAILED` - Read failed
+ * - `READY` - Ready
  */
 export declare enum DocumentCatalogStatus {
     CATALOGUED = "CATALOGUED",
+    DELETED = "DELETED",
     DESCRIBED = "DESCRIBED",
     DESCRIBE_FAILED = "DESCRIBE_FAILED",
-    DESCRIBE_PENDING = "DESCRIBE_PENDING"
+    DESCRIBE_PENDING = "DESCRIBE_PENDING",
+    EMBEDDED = "EMBEDDED",
+    EMBED_FAILED = "EMBED_FAILED",
+    READ = "READ",
+    READ_FAILED = "READ_FAILED",
+    READY = "READY"
+}
+/**
+ * Valid values for Document.FieldsReviewState
+ *
+ * Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed.
+ *
+ * @remarks Available options:
+ * - `CONFIRMED` - Confirmed
+ * - `NEEDS_REVIEW` - Needs review
+ * - `NOT_EXTRACTED` - Not extracted
+ */
+export declare enum DocumentFieldsReviewState {
+    CONFIRMED = "CONFIRMED",
+    NEEDS_REVIEW = "NEEDS_REVIEW",
+    NOT_EXTRACTED = "NOT_EXTRACTED"
 }
 /**
  * Property keys for Document
@@ -140,7 +171,25 @@ export declare enum DocumentPropertyKeys {
     /** When a pipeline last ran on the document. */
     LastProcessedAt = "LastProcessedAt",
     /** Id of the most recent DocumentProcessing row. */
-    LastProcessingId = "LastProcessingId"
+    LastProcessingId = "LastProcessingId",
+    /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report. */
+    IsTemplate = "IsTemplate",
+    /** The parties as the document names them, separated by " and ". A blank in a template is left blank. */
+    Parties = "Parties",
+    /** The party that is not us. Blank in a template. */
+    Counterparty = "Counterparty",
+    /** The date the document is dated or was adopted. Blank in a template. */
+    DocumentDate = "DocumentDate",
+    /** The term or confidentiality period in months, when the document states one. */
+    TermMonths = "TermMonths",
+    /** The governing law as the document names it, e.g. England and Wales. */
+    GoverningLaw = "GoverningLaw",
+    /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed. */
+    FieldsReviewState = "FieldsReviewState",
+    /** 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"
 }
 /**
  * Properties for Document records
@@ -295,13 +344,68 @@ export interface DocumentProperties {
      * @default
      */
     LastProcessingId: string;
+    /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsTemplate: boolean;
+    /** The parties as the document names them, separated by " and ". A blank in a template is left blank.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Parties: string;
+    /** The party that is not us. Blank in a template.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Counterparty: string;
+    /** The date the document is dated or was adopted. Blank in a template.
+     *
+     * @type {DATE}
+     * @default
+     */
+    DocumentDate: string;
+    /** The term or confidentiality period in months, when the document states one.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    TermMonths: number;
+    /** The governing law as the document names it, e.g. England and Wales.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    GoverningLaw: string;
+    /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed.
+     *
+     * @type {ENUM}
+     * @default NOT_EXTRACTED
+     * @enum {DocumentFieldsReviewState}
+     */
+    FieldsReviewState: DocumentFieldsReviewState;
+    /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    FolderKey: string;
+    /** How many sections the read step produced; equals the number of vectors.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    SectionCount: number;
 }
 /**
- * Properties for CONTRACT_BUYOUT Document records
+ * Properties for CONTRACT Document records
  *
  * @see AiModule:Document
  */
-export interface ContractBuyoutDocumentProperties {
+export interface ContractDocumentProperties {
     /** Module of the record the document belongs to, e.g. FieldServiceModule.
      *
      * @type {TEXT}
@@ -449,13 +553,68 @@ export interface ContractBuyoutDocumentProperties {
      * @default
      */
     LastProcessingId: string;
+    /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsTemplate: boolean;
+    /** The parties as the document names them, separated by " and ". A blank in a template is left blank.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Parties: string;
+    /** The party that is not us. Blank in a template.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Counterparty: string;
+    /** The date the document is dated or was adopted. Blank in a template.
+     *
+     * @type {DATE}
+     * @default
+     */
+    DocumentDate: string;
+    /** The term or confidentiality period in months, when the document states one.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    TermMonths: number;
+    /** The governing law as the document names it, e.g. England and Wales.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    GoverningLaw: string;
+    /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed.
+     *
+     * @type {ENUM}
+     * @default NOT_EXTRACTED
+     * @enum {DocumentFieldsReviewState}
+     */
+    FieldsReviewState: DocumentFieldsReviewState;
+    /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    FolderKey: string;
+    /** How many sections the read step produced; equals the number of vectors.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    SectionCount: number;
 }
 /**
- * Properties for EMAIL_ATTACHMENT Document records
+ * Properties for CONTRACT_BUYOUT Document records
  *
  * @see AiModule:Document
  */
-export interface EmailAttachmentDocumentProperties {
+export interface ContractBuyoutDocumentProperties {
     /** Module of the record the document belongs to, e.g. FieldServiceModule.
      *
      * @type {TEXT}
@@ -603,13 +762,68 @@ export interface EmailAttachmentDocumentProperties {
      * @default
      */
     LastProcessingId: string;
+    /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsTemplate: boolean;
+    /** The parties as the document names them, separated by " and ". A blank in a template is left blank.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Parties: string;
+    /** The party that is not us. Blank in a template.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Counterparty: string;
+    /** The date the document is dated or was adopted. Blank in a template.
+     *
+     * @type {DATE}
+     * @default
+     */
+    DocumentDate: string;
+    /** The term or confidentiality period in months, when the document states one.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    TermMonths: number;
+    /** The governing law as the document names it, e.g. England and Wales.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    GoverningLaw: string;
+    /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed.
+     *
+     * @type {ENUM}
+     * @default NOT_EXTRACTED
+     * @enum {DocumentFieldsReviewState}
+     */
+    FieldsReviewState: DocumentFieldsReviewState;
+    /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    FolderKey: string;
+    /** How many sections the read step produced; equals the number of vectors.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    SectionCount: number;
 }
 /**
- * Properties for INVOICE Document records
+ * Properties for CORPORATE_DOCUMENT Document records
  *
  * @see AiModule:Document
  */
-export interface InvoiceDocumentProperties {
+export interface CorporateDocumentDocumentProperties {
     /** Module of the record the document belongs to, e.g. FieldServiceModule.
      *
      * @type {TEXT}
@@ -757,13 +971,68 @@ export interface InvoiceDocumentProperties {
      * @default
      */
     LastProcessingId: string;
+    /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsTemplate: boolean;
+    /** The parties as the document names them, separated by " and ". A blank in a template is left blank.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Parties: string;
+    /** The party that is not us. Blank in a template.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Counterparty: string;
+    /** The date the document is dated or was adopted. Blank in a template.
+     *
+     * @type {DATE}
+     * @default
+     */
+    DocumentDate: string;
+    /** The term or confidentiality period in months, when the document states one.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    TermMonths: number;
+    /** The governing law as the document names it, e.g. England and Wales.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    GoverningLaw: string;
+    /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed.
+     *
+     * @type {ENUM}
+     * @default NOT_EXTRACTED
+     * @enum {DocumentFieldsReviewState}
+     */
+    FieldsReviewState: DocumentFieldsReviewState;
+    /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    FolderKey: string;
+    /** How many sections the read step produced; equals the number of vectors.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    SectionCount: number;
 }
 /**
- * Properties for OTHER Document records
+ * Properties for EMAIL_ATTACHMENT Document records
  *
  * @see AiModule:Document
  */
-export interface OtherDocumentProperties {
+export interface EmailAttachmentDocumentProperties {
     /** Module of the record the document belongs to, e.g. FieldServiceModule.
      *
      * @type {TEXT}
@@ -911,13 +1180,68 @@ export interface OtherDocumentProperties {
      * @default
      */
     LastProcessingId: string;
+    /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsTemplate: boolean;
+    /** The parties as the document names them, separated by " and ". A blank in a template is left blank.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Parties: string;
+    /** The party that is not us. Blank in a template.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Counterparty: string;
+    /** The date the document is dated or was adopted. Blank in a template.
+     *
+     * @type {DATE}
+     * @default
+     */
+    DocumentDate: string;
+    /** The term or confidentiality period in months, when the document states one.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    TermMonths: number;
+    /** The governing law as the document names it, e.g. England and Wales.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    GoverningLaw: string;
+    /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed.
+     *
+     * @type {ENUM}
+     * @default NOT_EXTRACTED
+     * @enum {DocumentFieldsReviewState}
+     */
+    FieldsReviewState: DocumentFieldsReviewState;
+    /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    FolderKey: string;
+    /** How many sections the read step produced; equals the number of vectors.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    SectionCount: number;
 }
 /**
- * Properties for OUTCOME_FORM Document records
+ * Properties for INVOICE Document records
  *
  * @see AiModule:Document
  */
-export interface OutcomeFormDocumentProperties {
+export interface InvoiceDocumentProperties {
     /** Module of the record the document belongs to, e.g. FieldServiceModule.
      *
      * @type {TEXT}
@@ -1065,6 +1389,479 @@ export interface OutcomeFormDocumentProperties {
      * @default
      */
     LastProcessingId: string;
+    /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsTemplate: boolean;
+    /** The parties as the document names them, separated by " and ". A blank in a template is left blank.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Parties: string;
+    /** The party that is not us. Blank in a template.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Counterparty: string;
+    /** The date the document is dated or was adopted. Blank in a template.
+     *
+     * @type {DATE}
+     * @default
+     */
+    DocumentDate: string;
+    /** The term or confidentiality period in months, when the document states one.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    TermMonths: number;
+    /** The governing law as the document names it, e.g. England and Wales.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    GoverningLaw: string;
+    /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed.
+     *
+     * @type {ENUM}
+     * @default NOT_EXTRACTED
+     * @enum {DocumentFieldsReviewState}
+     */
+    FieldsReviewState: DocumentFieldsReviewState;
+    /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    FolderKey: string;
+    /** How many sections the read step produced; equals the number of vectors.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    SectionCount: number;
+}
+/**
+ * Properties for OTHER Document records
+ *
+ * @see AiModule:Document
+ */
+export interface OtherDocumentProperties {
+    /** Module of the record the document belongs to, e.g. FieldServiceModule.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SourceModule: string;
+    /** Entity of the source record, e.g. RegionNInternalInstallForm.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SourceEntity: string;
+    /** Id of the source record. With SourceEntity, the key the helper upserts on.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SourceRecordId: string;
+    /** Record number of the source record, for people.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SourceRecordNumber: string;
+    /** The File records that make up the document: photos, signatures, PDFs.
+     *
+     * @type {FILE_MULTIPLE}
+     * @default
+     */
+    Files: string;
+    /** Number of File records in Files.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    FileCount: number;
+    /** Finer kind within the record type: the form entity name, the previous provider, the invoice type.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SubType: string;
+    /** Physical shape of the document.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {DocumentFormat}
+     */
+    Format: DocumentFormat;
+    /** User or contact id that submitted the document.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SubmittedById: string;
+    /** Name of the user or contact that submitted the document.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SubmittedByName: string;
+    /** When the source record was created.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    SubmittedAt: string;
+    /** The channel the document arrived through.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {DocumentSubmittedVia}
+     */
+    SubmittedVia: DocumentSubmittedVia;
+    /** The business record the document belongs to: FieldServiceModule:WorkOrder, OrderModule:Order, CrmModule:Account.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    BusinessRecordEntity: string;
+    /** Id of that business record.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    BusinessRecordId: string;
+    /** AI-written plain-English description of what the document is and contains. Capped at 1,500 characters by the writer.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    Description: string;
+    /** One line per image or page. Capped at 400 characters by the writer.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    ContentsSummary: string;
+    /** Number of images in the document.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ImageCount: number;
+    /** Number of pages, for PDFs and HTML.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    PageCount: number;
+    /** Language of the document, ISO 639-1, e.g. en.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Language: string;
+    /** True when the description or the document carries names, addresses or signatures.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    ContainsPii: boolean;
+    /** Where the document is in the catalog pipeline.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {DocumentCatalogStatus}
+     */
+    CatalogStatus: DocumentCatalogStatus;
+    /** When the catalog first saw the document.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    FirstSeenAt: string;
+    /** When a pipeline last ran on the document.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    LastProcessedAt: string;
+    /** Id of the most recent DocumentProcessing row.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    LastProcessingId: string;
+    /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsTemplate: boolean;
+    /** The parties as the document names them, separated by " and ". A blank in a template is left blank.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Parties: string;
+    /** The party that is not us. Blank in a template.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Counterparty: string;
+    /** The date the document is dated or was adopted. Blank in a template.
+     *
+     * @type {DATE}
+     * @default
+     */
+    DocumentDate: string;
+    /** The term or confidentiality period in months, when the document states one.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    TermMonths: number;
+    /** The governing law as the document names it, e.g. England and Wales.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    GoverningLaw: string;
+    /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed.
+     *
+     * @type {ENUM}
+     * @default NOT_EXTRACTED
+     * @enum {DocumentFieldsReviewState}
+     */
+    FieldsReviewState: DocumentFieldsReviewState;
+    /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    FolderKey: string;
+    /** How many sections the read step produced; equals the number of vectors.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    SectionCount: number;
+}
+/**
+ * Properties for OUTCOME_FORM Document records
+ *
+ * @see AiModule:Document
+ */
+export interface OutcomeFormDocumentProperties {
+    /** Module of the record the document belongs to, e.g. FieldServiceModule.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SourceModule: string;
+    /** Entity of the source record, e.g. RegionNInternalInstallForm.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SourceEntity: string;
+    /** Id of the source record. With SourceEntity, the key the helper upserts on.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SourceRecordId: string;
+    /** Record number of the source record, for people.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SourceRecordNumber: string;
+    /** The File records that make up the document: photos, signatures, PDFs.
+     *
+     * @type {FILE_MULTIPLE}
+     * @default
+     */
+    Files: string;
+    /** Number of File records in Files.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    FileCount: number;
+    /** Finer kind within the record type: the form entity name, the previous provider, the invoice type.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SubType: string;
+    /** Physical shape of the document.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {DocumentFormat}
+     */
+    Format: DocumentFormat;
+    /** User or contact id that submitted the document.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SubmittedById: string;
+    /** Name of the user or contact that submitted the document.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SubmittedByName: string;
+    /** When the source record was created.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    SubmittedAt: string;
+    /** The channel the document arrived through.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {DocumentSubmittedVia}
+     */
+    SubmittedVia: DocumentSubmittedVia;
+    /** The business record the document belongs to: FieldServiceModule:WorkOrder, OrderModule:Order, CrmModule:Account.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    BusinessRecordEntity: string;
+    /** Id of that business record.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    BusinessRecordId: string;
+    /** AI-written plain-English description of what the document is and contains. Capped at 1,500 characters by the writer.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    Description: string;
+    /** One line per image or page. Capped at 400 characters by the writer.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    ContentsSummary: string;
+    /** Number of images in the document.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ImageCount: number;
+    /** Number of pages, for PDFs and HTML.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    PageCount: number;
+    /** Language of the document, ISO 639-1, e.g. en.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Language: string;
+    /** True when the description or the document carries names, addresses or signatures.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    ContainsPii: boolean;
+    /** Where the document is in the catalog pipeline.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {DocumentCatalogStatus}
+     */
+    CatalogStatus: DocumentCatalogStatus;
+    /** When the catalog first saw the document.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    FirstSeenAt: string;
+    /** When a pipeline last ran on the document.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    LastProcessedAt: string;
+    /** Id of the most recent DocumentProcessing row.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    LastProcessingId: string;
+    /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    IsTemplate: boolean;
+    /** The parties as the document names them, separated by " and ". A blank in a template is left blank.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Parties: string;
+    /** The party that is not us. Blank in a template.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Counterparty: string;
+    /** The date the document is dated or was adopted. Blank in a template.
+     *
+     * @type {DATE}
+     * @default
+     */
+    DocumentDate: string;
+    /** The term or confidentiality period in months, when the document states one.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    TermMonths: number;
+    /** The governing law as the document names it, e.g. England and Wales.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    GoverningLaw: string;
+    /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed.
+     *
+     * @type {ENUM}
+     * @default NOT_EXTRACTED
+     * @enum {DocumentFieldsReviewState}
+     */
+    FieldsReviewState: DocumentFieldsReviewState;
+    /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    FolderKey: string;
+    /** How many sections the read step produced; equals the number of vectors.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    SectionCount: number;
 }
 /**
  * Document entity from AiModule
@@ -1099,12 +1896,24 @@ export declare const ROUTING_KEY_DOCUMENT_DELETED = "AiModule.Document.SubDbReco
  * Type-specific routing keys for Document events
  * Subscribe to these for events on specific entity types only
  */
+/** An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind. created */
+export declare const ROUTING_KEY_DOCUMENT_CONTRACT_CREATED = "AiModule.Document.CONTRACT.SubDbRecordCreated";
+/** An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind. updated */
+export declare const ROUTING_KEY_DOCUMENT_CONTRACT_UPDATED = "AiModule.Document.CONTRACT.SubDbRecordUpdated";
+/** An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind. deleted */
+export declare const ROUTING_KEY_DOCUMENT_CONTRACT_DELETED = "AiModule.Document.CONTRACT.SubDbRecordDeleted";
 /** A customer's previous-provider final bill sent for a contract buyout (YouFibre orders). created */
 export declare const ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_CREATED = "AiModule.Document.CONTRACT_BUYOUT.SubDbRecordCreated";
 /** A customer's previous-provider final bill sent for a contract buyout (YouFibre orders). updated */
 export declare const ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_UPDATED = "AiModule.Document.CONTRACT_BUYOUT.SubDbRecordUpdated";
 /** A customer's previous-provider final bill sent for a contract buyout (YouFibre orders). deleted */
 export declare const ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_DELETED = "AiModule.Document.CONTRACT_BUYOUT.SubDbRecordDeleted";
+/** A document about the company itself: articles of association, resolutions, filings. SubType says which kind. created */
+export declare const ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_CREATED = "AiModule.Document.CORPORATE_DOCUMENT.SubDbRecordCreated";
+/** A document about the company itself: articles of association, resolutions, filings. SubType says which kind. updated */
+export declare const ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_UPDATED = "AiModule.Document.CORPORATE_DOCUMENT.SubDbRecordUpdated";
+/** A document about the company itself: articles of association, resolutions, filings. SubType says which kind. deleted */
+export declare const ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_DELETED = "AiModule.Document.CORPORATE_DOCUMENT.SubDbRecordDeleted";
 /** This is the default record type created */
 export declare const ROUTING_KEY_DOCUMENT_DEFAULT_CREATED = "AiModule.Document.DEFAULT.SubDbRecordCreated";
 /** This is the default record type updated */