@d19n/youfibre-odin-sdk 2.0.371 → 2.0.372

package/dist/entities-v2/Document.js

@@ -12,15 +12,19 @@
  * 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_CONTRACT_BUYOUT_DELETED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_CREATED = exports.ROUTING_KEY_DOCUMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CREATED = exports.Document = exports.DocumentPropertyKeys = exports.DocumentCatalogStatus = exports.DocumentSubmittedVia = exports.DocumentFormat = exports.DocumentEntityTypes = void 0;
+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
  */
 var DocumentEntityTypes;
 (function (DocumentEntityTypes) {
+    /** An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind. */
+    DocumentEntityTypes["CONTRACT"] = "CONTRACT";
     /** A customer's previous-provider final bill sent for a contract buyout (YouFibre orders). */
     DocumentEntityTypes["CONTRACT_BUYOUT"] = "CONTRACT_BUYOUT";
+    /** A document about the company itself: articles of association, resolutions, filings. SubType says which kind. */
+    DocumentEntityTypes["CORPORATE_DOCUMENT"] = "CORPORATE_DOCUMENT";
     /** This is the default record type */
     DocumentEntityTypes["DEFAULT"] = "DEFAULT";
     /** A file attached to an inbound or outbound email. */
@@ -81,17 +85,45 @@ var 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
  */
 var DocumentCatalogStatus;
 (function (DocumentCatalogStatus) {
     DocumentCatalogStatus["CATALOGUED"] = "CATALOGUED";
+    DocumentCatalogStatus["DELETED"] = "DELETED";
     DocumentCatalogStatus["DESCRIBED"] = "DESCRIBED";
     DocumentCatalogStatus["DESCRIBE_FAILED"] = "DESCRIBE_FAILED";
     DocumentCatalogStatus["DESCRIBE_PENDING"] = "DESCRIBE_PENDING";
+    DocumentCatalogStatus["EMBEDDED"] = "EMBEDDED";
+    DocumentCatalogStatus["EMBED_FAILED"] = "EMBED_FAILED";
+    DocumentCatalogStatus["READ"] = "READ";
+    DocumentCatalogStatus["READ_FAILED"] = "READ_FAILED";
+    DocumentCatalogStatus["READY"] = "READY";
 })(DocumentCatalogStatus = exports.DocumentCatalogStatus || (exports.DocumentCatalogStatus = {}));
+/**
+ * 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
+ */
+var DocumentFieldsReviewState;
+(function (DocumentFieldsReviewState) {
+    DocumentFieldsReviewState["CONFIRMED"] = "CONFIRMED";
+    DocumentFieldsReviewState["NEEDS_REVIEW"] = "NEEDS_REVIEW";
+    DocumentFieldsReviewState["NOT_EXTRACTED"] = "NOT_EXTRACTED";
+})(DocumentFieldsReviewState = exports.DocumentFieldsReviewState || (exports.DocumentFieldsReviewState = {}));
 /**
  * Property keys for Document
  * Use these constants instead of string literals for type safety
@@ -146,6 +178,24 @@ var DocumentPropertyKeys;
     DocumentPropertyKeys["LastProcessedAt"] = "LastProcessedAt";
     /** Id of the most recent DocumentProcessing row. */
     DocumentPropertyKeys["LastProcessingId"] = "LastProcessingId";
+    /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report. */
+    DocumentPropertyKeys["IsTemplate"] = "IsTemplate";
+    /** The parties as the document names them, separated by " and ". A blank in a template is left blank. */
+    DocumentPropertyKeys["Parties"] = "Parties";
+    /** The party that is not us. Blank in a template. */
+    DocumentPropertyKeys["Counterparty"] = "Counterparty";
+    /** The date the document is dated or was adopted. Blank in a template. */
+    DocumentPropertyKeys["DocumentDate"] = "DocumentDate";
+    /** The term or confidentiality period in months, when the document states one. */
+    DocumentPropertyKeys["TermMonths"] = "TermMonths";
+    /** The governing law as the document names it, e.g. England and Wales. */
+    DocumentPropertyKeys["GoverningLaw"] = "GoverningLaw";
+    /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed. */
+    DocumentPropertyKeys["FieldsReviewState"] = "FieldsReviewState";
+    /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history. */
+    DocumentPropertyKeys["FolderKey"] = "FolderKey";
+    /** How many sections the read step produced; equals the number of vectors. */
+    DocumentPropertyKeys["SectionCount"] = "SectionCount";
 })(DocumentPropertyKeys = exports.DocumentPropertyKeys || (exports.DocumentPropertyKeys = {}));
 /**
  * Document entity from AiModule
@@ -174,12 +224,24 @@ exports.ROUTING_KEY_DOCUMENT_DELETED = 'AiModule.Document.SubDbRecordDeleted';
  * 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 */
+exports.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 */
+exports.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 */
+exports.ROUTING_KEY_DOCUMENT_CONTRACT_DELETED = 'AiModule.Document.CONTRACT.SubDbRecordDeleted';
 /** A customer's previous-provider final bill sent for a contract buyout (YouFibre orders). created */
 exports.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 */
 exports.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 */
 exports.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 */
+exports.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 */
+exports.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 */
+exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_DELETED = 'AiModule.Document.CORPORATE_DOCUMENT.SubDbRecordDeleted';
 /** This is the default record type created */
 exports.ROUTING_KEY_DOCUMENT_DEFAULT_CREATED = 'AiModule.Document.DEFAULT.SubDbRecordCreated';
 /** This is the default record type updated */

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

@@ -27,17 +27,23 @@ export declare enum DocumentProcessingEntityTypes {
  *
  * @remarks Available options:
  * - `CBO_FINAL_BILL_CHECK` - CBO final bill check
+ * - `CHAT` - Chat
  * - `DESCRIBE` - Describe
  * - `EMBED` - Embed
+ * - `EXTRACT_FIELDS` - Extract fields
  * - `EXTRACT` - Extract text
  * - `OUTCOME_FORM_REVIEW` - Outcome form review
+ * - `TEMPLATE_REPORT` - Template report
  */
 export declare enum DocumentProcessingUseCase {
     CBO_FINAL_BILL_CHECK = "CBO_FINAL_BILL_CHECK",
+    CHAT = "CHAT",
     DESCRIBE = "DESCRIBE",
     EMBED = "EMBED",
+    EXTRACT_FIELDS = "EXTRACT_FIELDS",
     EXTRACT_TEXT = "EXTRACT",
-    OUTCOME_FORM_REVIEW = "OUTCOME_FORM_REVIEW"
+    OUTCOME_FORM_REVIEW = "OUTCOME_FORM_REVIEW",
+    TEMPLATE_REPORT = "TEMPLATE_REPORT"
 }
 /**
  * Valid values for DocumentProcessing.Provider

package/dist/entities-v2/DocumentProcessing.js

@@ -29,18 +29,24 @@ var DocumentProcessingEntityTypes;
  *
  * @remarks Available options:
  * - `CBO_FINAL_BILL_CHECK` - CBO final bill check
+ * - `CHAT` - Chat
  * - `DESCRIBE` - Describe
  * - `EMBED` - Embed
+ * - `EXTRACT_FIELDS` - Extract fields
  * - `EXTRACT` - Extract text
  * - `OUTCOME_FORM_REVIEW` - Outcome form review
+ * - `TEMPLATE_REPORT` - Template report
  */
 var DocumentProcessingUseCase;
 (function (DocumentProcessingUseCase) {
     DocumentProcessingUseCase["CBO_FINAL_BILL_CHECK"] = "CBO_FINAL_BILL_CHECK";
+    DocumentProcessingUseCase["CHAT"] = "CHAT";
     DocumentProcessingUseCase["DESCRIBE"] = "DESCRIBE";
     DocumentProcessingUseCase["EMBED"] = "EMBED";
+    DocumentProcessingUseCase["EXTRACT_FIELDS"] = "EXTRACT_FIELDS";
     DocumentProcessingUseCase["EXTRACT_TEXT"] = "EXTRACT";
     DocumentProcessingUseCase["OUTCOME_FORM_REVIEW"] = "OUTCOME_FORM_REVIEW";
+    DocumentProcessingUseCase["TEMPLATE_REPORT"] = "TEMPLATE_REPORT";
 })(DocumentProcessingUseCase = exports.DocumentProcessingUseCase || (exports.DocumentProcessingUseCase = {}));
 /**
  * Valid values for DocumentProcessing.Provider

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

@@ -56,7 +56,9 @@ export declare enum OutboundDialCampaignPropertyKeys {
     /** Override Twilio CLI Outbound number in case needed for different campaigns */
     CallerId = "CallerId",
     /** How cases reach agents: SELF_SELECT (agents pick from the queue) or ROUND_ROBIN (the dialler hands new cases to agents in turn, CASES-1984). Empty means SELF_SELECT. */
-    DistributionMode = "DistributionMode"
+    DistributionMode = "DistributionMode",
+    /** When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false. */
+    RetentionCampaign = "RetentionCampaign"
 }
 /**
  * Properties for OutboundDialCampaign records
@@ -110,6 +112,12 @@ export interface OutboundDialCampaignProperties {
      * @default
      */
     DistributionMode: string;
+    /** When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false.
+     *
+     * @type {BOOLEAN}
+     * @default
+     */
+    RetentionCampaign: boolean;
 }
 /**
  * OutboundDialCampaign entity from SupportModule

package/dist/entities-v2/OutboundDialCampaign.js

@@ -58,6 +58,8 @@ var OutboundDialCampaignPropertyKeys;
     OutboundDialCampaignPropertyKeys["CallerId"] = "CallerId";
     /** How cases reach agents: SELF_SELECT (agents pick from the queue) or ROUND_ROBIN (the dialler hands new cases to agents in turn, CASES-1984). Empty means SELF_SELECT. */
     OutboundDialCampaignPropertyKeys["DistributionMode"] = "DistributionMode";
+    /** When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false. */
+    OutboundDialCampaignPropertyKeys["RetentionCampaign"] = "RetentionCampaign";
 })(OutboundDialCampaignPropertyKeys = exports.OutboundDialCampaignPropertyKeys || (exports.OutboundDialCampaignPropertyKeys = {}));
 /**
  * OutboundDialCampaign entity from SupportModule

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

@@ -218,14 +218,14 @@ export declare enum ReturnsCpe4Type {
  * Cpe 5 Grade (Field Operations - Returns)
  *
  * @remarks Available options:
- * - `B` - Fail - Cosmetic
- * - `C` - Fail - Technical
- * - `A` - Pass
+ * - `E` - Fail - Cosmetic
+ * - `F` - Fail - Technical
+ * - `D` - Pass
  */
 export declare enum ReturnsCpe5Grade {
-    FAIL_COSMETIC = "B",
-    FAIL_TECHNICAL = "C",
-    PASS = "A"
+    FAIL_COSMETIC = "E",
+    FAIL_TECHNICAL = "F",
+    PASS = "D"
 }
 /**
  * Valid values for Returns.Cpe3Model
@@ -283,14 +283,14 @@ export declare enum ReturnsCpe3Model {
  * Cpe 1 Grade (Field Operations - Returns)
  *
  * @remarks Available options:
- * - `B` - Fail - Cosmetic
- * - `C` - Fail - Technical
- * - `A` - Pass
+ * - `E` - Fail - Cosmetic
+ * - `F` - Fail - Technical
+ * - `D` - Pass
  */
 export declare enum ReturnsCpe1Grade {
-    FAIL_COSMETIC = "B",
-    FAIL_TECHNICAL = "C",
-    PASS = "A"
+    FAIL_COSMETIC = "E",
+    FAIL_TECHNICAL = "F",
+    PASS = "D"
 }
 /**
  * Valid values for Returns.Cpe2Type
@@ -473,14 +473,14 @@ export declare enum ReturnsCpe2Model {
  * Cpe 4 Grade (Field Operations - Returns)
  *
  * @remarks Available options:
- * - `B` - Fail - Cosmetic
- * - `C` - Fail - Technical
- * - `A` - Pass
+ * - `E` - Fail - Cosmetic
+ * - `F` - Fail - Technical
+ * - `D` - Pass
  */
 export declare enum ReturnsCpe4Grade {
-    FAIL_COSMETIC = "B",
-    FAIL_TECHNICAL = "C",
-    PASS = "A"
+    FAIL_COSMETIC = "E",
+    FAIL_TECHNICAL = "F",
+    PASS = "D"
 }
 /**
  * Valid values for Returns.InspectedBy
@@ -507,14 +507,14 @@ export declare enum ReturnsInspectedBy {
  * Cpe 3 Grade (Field Operations - Returns)
  *
  * @remarks Available options:
- * - `B` - Fail - Cosmetic
- * - `C` - Fail - Technical
- * - `A` - Pass
+ * - `E` - Fail - Cosmetic
+ * - `F` - Fail - Technical
+ * - `D` - Pass
  */
 export declare enum ReturnsCpe3Grade {
-    FAIL_COSMETIC = "B",
-    FAIL_TECHNICAL = "C",
-    PASS = "A"
+    FAIL_COSMETIC = "E",
+    FAIL_TECHNICAL = "F",
+    PASS = "D"
 }
 /**
  * Valid values for Returns.Tv1Type
@@ -535,14 +535,14 @@ export declare enum ReturnsTv1Type {
  * Cpe 2 Grade (Field Operations - Returns)
  *
  * @remarks Available options:
- * - `B` - Fail - Cosmetic
- * - `C` - Fail - Technical
- * - `A` - Pass
+ * - `E` - Fail - Cosmetic
+ * - `F` - Fail - Technical
+ * - `D` - Pass
  */
 export declare enum ReturnsCpe2Grade {
-    FAIL_COSMETIC = "B",
-    FAIL_TECHNICAL = "C",
-    PASS = "A"
+    FAIL_COSMETIC = "E",
+    FAIL_TECHNICAL = "F",
+    PASS = "D"
 }
 /**
  * Property keys for Returns

package/dist/entities-v2/Returns.js

@@ -225,15 +225,15 @@ var ReturnsCpe4Type;
  * Cpe 5 Grade (Field Operations - Returns)
  *
  * @remarks Available options:
- * - `B` - Fail - Cosmetic
- * - `C` - Fail - Technical
- * - `A` - Pass
+ * - `E` - Fail - Cosmetic
+ * - `F` - Fail - Technical
+ * - `D` - Pass
  */
 var ReturnsCpe5Grade;
 (function (ReturnsCpe5Grade) {
-    ReturnsCpe5Grade["FAIL_COSMETIC"] = "B";
-    ReturnsCpe5Grade["FAIL_TECHNICAL"] = "C";
-    ReturnsCpe5Grade["PASS"] = "A";
+    ReturnsCpe5Grade["FAIL_COSMETIC"] = "E";
+    ReturnsCpe5Grade["FAIL_TECHNICAL"] = "F";
+    ReturnsCpe5Grade["PASS"] = "D";
 })(ReturnsCpe5Grade = exports.ReturnsCpe5Grade || (exports.ReturnsCpe5Grade = {}));
 /**
  * Valid values for Returns.Cpe3Model
@@ -292,15 +292,15 @@ var ReturnsCpe3Model;
  * Cpe 1 Grade (Field Operations - Returns)
  *
  * @remarks Available options:
- * - `B` - Fail - Cosmetic
- * - `C` - Fail - Technical
- * - `A` - Pass
+ * - `E` - Fail - Cosmetic
+ * - `F` - Fail - Technical
+ * - `D` - Pass
  */
 var ReturnsCpe1Grade;
 (function (ReturnsCpe1Grade) {
-    ReturnsCpe1Grade["FAIL_COSMETIC"] = "B";
-    ReturnsCpe1Grade["FAIL_TECHNICAL"] = "C";
-    ReturnsCpe1Grade["PASS"] = "A";
+    ReturnsCpe1Grade["FAIL_COSMETIC"] = "E";
+    ReturnsCpe1Grade["FAIL_TECHNICAL"] = "F";
+    ReturnsCpe1Grade["PASS"] = "D";
 })(ReturnsCpe1Grade = exports.ReturnsCpe1Grade || (exports.ReturnsCpe1Grade = {}));
 /**
  * Valid values for Returns.Cpe2Type
@@ -488,15 +488,15 @@ var ReturnsCpe2Model;
  * Cpe 4 Grade (Field Operations - Returns)
  *
  * @remarks Available options:
- * - `B` - Fail - Cosmetic
- * - `C` - Fail - Technical
- * - `A` - Pass
+ * - `E` - Fail - Cosmetic
+ * - `F` - Fail - Technical
+ * - `D` - Pass
  */
 var ReturnsCpe4Grade;
 (function (ReturnsCpe4Grade) {
-    ReturnsCpe4Grade["FAIL_COSMETIC"] = "B";
-    ReturnsCpe4Grade["FAIL_TECHNICAL"] = "C";
-    ReturnsCpe4Grade["PASS"] = "A";
+    ReturnsCpe4Grade["FAIL_COSMETIC"] = "E";
+    ReturnsCpe4Grade["FAIL_TECHNICAL"] = "F";
+    ReturnsCpe4Grade["PASS"] = "D";
 })(ReturnsCpe4Grade = exports.ReturnsCpe4Grade || (exports.ReturnsCpe4Grade = {}));
 /**
  * Valid values for Returns.InspectedBy
@@ -524,15 +524,15 @@ var ReturnsInspectedBy;
  * Cpe 3 Grade (Field Operations - Returns)
  *
  * @remarks Available options:
- * - `B` - Fail - Cosmetic
- * - `C` - Fail - Technical
- * - `A` - Pass
+ * - `E` - Fail - Cosmetic
+ * - `F` - Fail - Technical
+ * - `D` - Pass
  */
 var ReturnsCpe3Grade;
 (function (ReturnsCpe3Grade) {
-    ReturnsCpe3Grade["FAIL_COSMETIC"] = "B";
-    ReturnsCpe3Grade["FAIL_TECHNICAL"] = "C";
-    ReturnsCpe3Grade["PASS"] = "A";
+    ReturnsCpe3Grade["FAIL_COSMETIC"] = "E";
+    ReturnsCpe3Grade["FAIL_TECHNICAL"] = "F";
+    ReturnsCpe3Grade["PASS"] = "D";
 })(ReturnsCpe3Grade = exports.ReturnsCpe3Grade || (exports.ReturnsCpe3Grade = {}));
 /**
  * Valid values for Returns.Tv1Type
@@ -554,15 +554,15 @@ var ReturnsTv1Type;
  * Cpe 2 Grade (Field Operations - Returns)
  *
  * @remarks Available options:
- * - `B` - Fail - Cosmetic
- * - `C` - Fail - Technical
- * - `A` - Pass
+ * - `E` - Fail - Cosmetic
+ * - `F` - Fail - Technical
+ * - `D` - Pass
  */
 var ReturnsCpe2Grade;
 (function (ReturnsCpe2Grade) {
-    ReturnsCpe2Grade["FAIL_COSMETIC"] = "B";
-    ReturnsCpe2Grade["FAIL_TECHNICAL"] = "C";
-    ReturnsCpe2Grade["PASS"] = "A";
+    ReturnsCpe2Grade["FAIL_COSMETIC"] = "E";
+    ReturnsCpe2Grade["FAIL_TECHNICAL"] = "F";
+    ReturnsCpe2Grade["PASS"] = "D";
 })(ReturnsCpe2Grade = exports.ReturnsCpe2Grade || (exports.ReturnsCpe2Grade = {}));
 /**
  * Property keys for Returns

package/dist/records-v2/ContactRecord.d.ts

@@ -24,6 +24,7 @@ import { ContactProperties } from '../entities-v2/Contact';
 import { CreateCaseProperties } from '../actions-v2/CreateCaseFromContactDto';
 import { CreateContactProperties } from '../actions-v2/CreateContactDto';
 import { CreateContactSalesAppProperties } from '../actions-v2/CreateContactSalesAppDto';
+import { OrderBuilderUpdateContactProperties } from '../actions-v2/OrderBuilderUpdateContactDto';
 import { UpdateAdditionalCareProperties } from '../actions-v2/UpdateAdditionalCareDto';
 import { UpdateContactAppPreferencesProperties } from '../actions-v2/UpdateContactAppPreferencesDto';
 import { UpdateContactProperties } from '../actions-v2/UpdateContactDto';
@@ -839,6 +840,32 @@ export declare class ContactRecord<TProps = ContactProperties> {
     createCaseFromContact(options?: {
         journeyId?: string;
     }): CreateCaseFromContactFlowBuilder;
+    /**
+     * OrderBuilderUpdateContact
+     *
+     * Updates this Contact record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
+     *
+     * @param properties - Required properties for this action
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @param options.stageKey - Transition to pipeline stage
+     * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.contacts.get(id);
+     * await record.orderBuilderUpdateContact({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.orderBuilderUpdateContact({ ... }).dryRun();
+     * ```
+     */
+    orderBuilderUpdateContact(properties: OrderBuilderUpdateContactProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    }): ActionBuilder;
     /**
      * UpdateAdditionalCare
      *

package/dist/records-v2/ContactRecord.js

@@ -1248,6 +1248,35 @@ class ContactRecord {
     createCaseFromContact(options) {
         return new CreateCaseFromContactFlowBuilder(this, this._provider, this._pendingLinks, options);
     }
+    /**
+     * OrderBuilderUpdateContact
+     *
+     * Updates this Contact record with the specified properties.
+     * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
+     *
+     * @param properties - Required properties for this action
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @param options.stageKey - Transition to pipeline stage
+     * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.contacts.get(id);
+     * await record.orderBuilderUpdateContact({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.orderBuilderUpdateContact({ ... }).dryRun();
+     * ```
+     */
+    orderBuilderUpdateContact(properties, options) {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('orderBuilderUpdateContact requires an existing record. Use accessor.get() first.');
+        const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'OrderBuilderUpdateContact', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
+        return new ActionBuilder(this._provider, 'CrmModule', 'Contact', payload, () => { this._pendingLinks = []; });
+    }
     /**
      * UpdateAdditionalCare
      *

package/dist/records-v2/DocumentRecord.d.ts

@@ -13,7 +13,7 @@
  * await record.createDocument({ ... }).execute();
  * ```
  *
- * Entity Types: CONTRACT_BUYOUT, DEFAULT, EMAIL_ATTACHMENT, INVOICE, OTHER, OUTCOME_FORM
+ * Entity Types: CONTRACT, CONTRACT_BUYOUT, CORPORATE_DOCUMENT, DEFAULT, EMAIL_ATTACHMENT, INVOICE, OTHER, OUTCOME_FORM
  *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
@@ -22,14 +22,14 @@ import { PipelineStageEntity } from '@d19n/odin-types/dist/core';
 import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/v1.db.interfaces';
 import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
 import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
-import { DocumentProperties, ContractBuyoutDocumentProperties, EmailAttachmentDocumentProperties, InvoiceDocumentProperties, OtherDocumentProperties, OutcomeFormDocumentProperties } from '../entities-v2/Document';
+import { DocumentProperties, ContractDocumentProperties, ContractBuyoutDocumentProperties, CorporateDocumentDocumentProperties, EmailAttachmentDocumentProperties, InvoiceDocumentProperties, OtherDocumentProperties, OutcomeFormDocumentProperties } from '../entities-v2/Document';
 import { CreateDocumentProperties } from '../actions-v2/CreateDocumentDto';
 import { UpdateDocumentProperties } from '../actions-v2/UpdateDocumentDto';
 import { FileRecord } from './FileRecord';
 import { DocumentProcessingRecord } from './DocumentProcessingRecord';
 import { ContractBuyOutRecord } from './ContractBuyOutRecord';
 /** Valid entity types for Document */
-export declare type DocumentType = 'CONTRACT_BUYOUT' | 'DEFAULT' | 'EMAIL_ATTACHMENT' | 'INVOICE' | 'OTHER' | 'OUTCOME_FORM';
+export declare type DocumentType = 'CONTRACT' | 'CONTRACT_BUYOUT' | 'CORPORATE_DOCUMENT' | 'DEFAULT' | 'EMAIL_ATTACHMENT' | 'INVOICE' | 'OTHER' | 'OUTCOME_FORM';
 /**
  * Builder for action execution with dryRun support
  *
@@ -123,6 +123,22 @@ export declare class DocumentRecord<TProps = DocumentProperties> {
     get links(): OdinRecord<TProps>['links'];
     /** Access the underlying OdinRecord (null for new records) */
     get record(): OdinRecord<TProps> | null;
+    /**
+     * Type guard: check if this record is of type CONTRACT
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to CONTRACT-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isContract()) {
+     *   // TypeScript knows record.properties is ContractDocumentProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind.
+     */
+    isContract(): this is DocumentRecord<ContractDocumentProperties>;
     /**
      * Type guard: check if this record is of type CONTRACT_BUYOUT
      *
@@ -139,6 +155,22 @@ export declare class DocumentRecord<TProps = DocumentProperties> {
      * @remarks A customer's previous-provider final bill sent for a contract buyout (YouFibre orders).
      */
     isContractBuyout(): this is DocumentRecord<ContractBuyoutDocumentProperties>;
+    /**
+     * Type guard: check if this record is of type CORPORATE_DOCUMENT
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to CORPORATE_DOCUMENT-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isCorporateDocument()) {
+     *   // TypeScript knows record.properties is CorporateDocumentDocumentProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks A document about the company itself: articles of association, resolutions, filings. SubType says which kind.
+     */
+    isCorporateDocument(): this is DocumentRecord<CorporateDocumentDocumentProperties>;
     /**
      * Type guard: check if this record is of type DEFAULT
      *

package/dist/records-v2/DocumentRecord.js

@@ -14,7 +14,7 @@
  * await record.createDocument({ ... }).execute();
  * ```
  *
- * Entity Types: CONTRACT_BUYOUT, DEFAULT, EMAIL_ATTACHMENT, INVOICE, OTHER, OUTCOME_FORM
+ * Entity Types: CONTRACT, CONTRACT_BUYOUT, CORPORATE_DOCUMENT, DEFAULT, EMAIL_ATTACHMENT, INVOICE, OTHER, OUTCOME_FORM
  *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  */
@@ -150,6 +150,22 @@ class DocumentRecord {
     // ============================================
     // TYPE GUARDS (with TypeScript type predicates)
     // ============================================
+    /**
+     * Type guard: check if this record is of type CONTRACT
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to CONTRACT-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isContract()) {
+     *   // TypeScript knows record.properties is ContractDocumentProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind.
+     */
+    isContract() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'CONTRACT'; }
     /**
      * Type guard: check if this record is of type CONTRACT_BUYOUT
      *
@@ -166,6 +182,22 @@ class DocumentRecord {
      * @remarks A customer's previous-provider final bill sent for a contract buyout (YouFibre orders).
      */
     isContractBuyout() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'CONTRACT_BUYOUT'; }
+    /**
+     * Type guard: check if this record is of type CORPORATE_DOCUMENT
+     *
+     * When this returns true, TypeScript automatically narrows the type,
+     * giving you access to CORPORATE_DOCUMENT-specific properties.
+     *
+     * @example
+     * ```typescript
+     * if (record.isCorporateDocument()) {
+     *   // TypeScript knows record.properties is CorporateDocumentDocumentProperties
+     *   console.log(record.properties.SomeTypeSpecificField);
+     * }
+     * ```
+     * @remarks A document about the company itself: articles of association, resolutions, filings. SubType says which kind.
+     */
+    isCorporateDocument() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'CORPORATE_DOCUMENT'; }
     /**
      * Type guard: check if this record is of type DEFAULT
      *

package/package.json

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