@d19n/youfibre-odin-sdk 2.0.377 → 2.0.379

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

@@ -0,0 +1,299 @@
+/**
+ * Contract Entity Definition
+ *
+ * The contract an order runs on: its number, its terms, and whether it is Active, Superseded (by a recontract) or Ended. Source of truth for the terms; the Order carries a read-only copy. Carried over to the new order on a home move.
+ *
+ * @module OrderModule
+ * @entity Contract
+ * @schemaId 7f5e71ff-040d-4e4e-8e1c-577e623c2319
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
+import { OrderProperties } from './Order';
+import { AccountProperties } from './Account';
+import { RecontractProperties } from './Recontract';
+/**
+ * Available types for Contract records
+ */
+export declare enum ContractEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * Valid values for Contract.Status
+ *
+ * Active: the contract the order runs on now. Superseded: replaced by a recontract. Ended: the service ended.
+ *
+ * @remarks Available options:
+ * - `ACTIVE` - Active
+ * - `ENDED` - Ended
+ * - `SUPERSEDED` - Superseded
+ */
+export declare enum ContractStatus {
+    ACTIVE = "ACTIVE",
+    ENDED = "ENDED",
+    SUPERSEDED = "SUPERSEDED"
+}
+/**
+ * Valid values for Contract.ContractType
+ *
+ * The minimum term. Same options as Order.ContractType.
+ *
+ * @remarks Available options:
+ * - `MONTHLY` - Monthly rolling
+ * - `NONE` - No contract
+ * - `ANNUAL_12` - Term 12 months
+ * - `ANNUAL_18` - Term 18 months
+ * - `ANNUAL_19` - Term 19 months
+ * - `ANNUAL_20` - Term 20 months
+ * - `ANNUAL_21` - Term 21 months
+ * - `ANNUAL_22` - Term 22 months
+ * - `ANNUAL_23` - Term 23 months
+ * - `ANNUAL_24` - Term 24 months
+ * - `ANNUAL_25` - Term 25 months
+ * - `ANNUAL_26` - Term 26 months
+ * - `ANNUAL_27` - Term 27 months
+ * - `ANNUAL_28` - Term 28 months
+ * - `ANNUAL_29` - Term 29 months
+ * - ... and 14 more
+ */
+export declare enum ContractContractType {
+    MONTHLY_ROLLING = "MONTHLY",
+    NO_CONTRACT = "NONE",
+    TERM_12_MONTHS = "ANNUAL_12",
+    TERM_18_MONTHS = "ANNUAL_18",
+    TERM_19_MONTHS = "ANNUAL_19",
+    TERM_20_MONTHS = "ANNUAL_20",
+    TERM_21_MONTHS = "ANNUAL_21",
+    TERM_22_MONTHS = "ANNUAL_22",
+    TERM_23_MONTHS = "ANNUAL_23",
+    TERM_24_MONTHS = "ANNUAL_24",
+    TERM_25_MONTHS = "ANNUAL_25",
+    TERM_26_MONTHS = "ANNUAL_26",
+    TERM_27_MONTHS = "ANNUAL_27",
+    TERM_28_MONTHS = "ANNUAL_28",
+    TERM_29_MONTHS = "ANNUAL_29",
+    TERM_30_MONTHS = "ANNUAL_30",
+    TERM_31_MONTHS = "ANNUAL_31",
+    TERM_32_MONTHS = "ANNUAL_32",
+    TERM_33_MONTHS = "ANNUAL_33",
+    TERM_34_MONTHS = "ANNUAL_34",
+    TERM_35_MONTHS = "ANNUAL_35",
+    TERM_36_MONTHS = "ANNUAL_36",
+    TERM_37_MONTHS = "ANNUAL_37",
+    TERM_38_MONTHS = "ANNUAL_38",
+    TERM_39_MONTHS = "ANNUAL_39",
+    TERM_40_MONTHS = "ANNUAL_40",
+    TERM_41_MONTHS = "ANNUAL_41",
+    TERM_42_MONTHS = "ANNUAL_42",
+    TERM_60_MONTHS = "ANNUAL_60"
+}
+/**
+ * Valid values for Contract.BillingTerms
+ *
+ * Payment terms. Same options as Order.BillingTerms.
+ *
+ * @remarks Available options:
+ * - `NET_0` - NET 0
+ * - `NET_10` - NET 10
+ * - `NET_120` - NET 120
+ * - `NET_15` - NET 15
+ * - `NET_3` - NET 3
+ * - `NET_30` - NET 30
+ * - `NET_60` - NET 60
+ * - `NET_90` - NET 90
+ */
+export declare enum ContractBillingTerms {
+    NET_0 = "NET_0",
+    NET_10 = "NET_10",
+    NET_120 = "NET_120",
+    NET_15 = "NET_15",
+    NET_3 = "NET_3",
+    NET_30 = "NET_30",
+    NET_60 = "NET_60",
+    NET_90 = "NET_90"
+}
+/**
+ * Property keys for Contract
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum ContractPropertyKeys {
+    /** The order's record number for its first contract; each recontract adds -R<n> (OR1849203-R1). Kept across a home move. Unique. */
+    ContractNumber = "ContractNumber",
+    /** Active: the contract the order runs on now. Superseded: replaced by a recontract. Ended: the service ended. */
+    Status = "Status",
+    /** The minimum term. Same options as Order.ContractType. */
+    ContractType = "ContractType",
+    /** The date the contract starts. */
+    ContractStartDate = "ContractStartDate",
+    /** The date the minimum term ends. */
+    ContractEndDate = "ContractEndDate",
+    /** How many times the contract has been renewed (recontracted). */
+    ContractRenewalCount = "ContractRenewalCount",
+    /** The billing anchor. On a home-moved order the order keeps its own (CORE-1492), so this can differ from the order it now runs on. */
+    BillingStartDate = "BillingStartDate",
+    /** The day of the month the customer is billed. */
+    BillingDay = "BillingDay",
+    /** The billing day the customer asked for at checkout. */
+    DesiredBillingDay = "DesiredBillingDay",
+    /** Payment terms. Same options as Order.BillingTerms. */
+    BillingTerms = "BillingTerms",
+    /** When the recontract that started this contract was applied. */
+    RecontractDate = "RecontractDate",
+    /** When the terms were last amended. */
+    AmendmentDate = "AmendmentDate",
+    /** The contract this one superseded, when it was started by a recontract. */
+    PreviousContractId = "PreviousContractId",
+    /** The order the contract runs on now. The only order its terms are copied to. */
+    NextOrderId = "NextOrderId",
+    /** The order the contract came from, when it was carried over a home move. Never written to: the terms go to NextOrderId only. */
+    PreviousOrderId = "PreviousOrderId"
+}
+/**
+ * Properties for Contract records
+ *
+ * @see OrderModule:Contract
+ */
+export interface ContractProperties {
+    /** The order's record number for its first contract; each recontract adds -R<n> (OR1849203-R1). Kept across a home move. Unique.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ContractNumber: string;
+    /** Active: the contract the order runs on now. Superseded: replaced by a recontract. Ended: the service ended.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {ContractStatus}
+     */
+    Status: ContractStatus;
+    /** The minimum term. Same options as Order.ContractType.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {ContractContractType}
+     */
+    ContractType: ContractContractType;
+    /** The date the contract starts.
+     *
+     * @type {DATE}
+     * @default
+     */
+    ContractStartDate: string;
+    /** The date the minimum term ends.
+     *
+     * @type {DATE}
+     * @default
+     */
+    ContractEndDate: string;
+    /** How many times the contract has been renewed (recontracted).
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ContractRenewalCount: number;
+    /** The billing anchor. On a home-moved order the order keeps its own (CORE-1492), so this can differ from the order it now runs on.
+     *
+     * @type {DATE}
+     * @default
+     */
+    BillingStartDate: string;
+    /** The day of the month the customer is billed.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    BillingDay: number;
+    /** The billing day the customer asked for at checkout.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    DesiredBillingDay: number;
+    /** Payment terms. Same options as Order.BillingTerms.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {ContractBillingTerms}
+     */
+    BillingTerms: ContractBillingTerms;
+    /** When the recontract that started this contract was applied.
+     *
+     * @type {DATE}
+     * @default
+     */
+    RecontractDate: string;
+    /** When the terms were last amended.
+     *
+     * @type {DATE}
+     * @default
+     */
+    AmendmentDate: string;
+    /** The contract this one superseded, when it was started by a recontract.
+     *
+     * @type {UUID}
+     * @default
+     */
+    PreviousContractId: string;
+    /** The order the contract runs on now. The only order its terms are copied to.
+     *
+     * @type {LOOKUP}
+     * @default
+     */
+    NextOrderId: string;
+    /** The order the contract came from, when it was carried over a home move. Never written to: the terms go to NextOrderId only.
+     *
+     * @type {LOOKUP}
+     * @default
+     */
+    PreviousOrderId: string;
+}
+/**
+ * Contract entity from OrderModule
+ *
+ * The contract an order runs on: its number, its terms, and whether it is Active, Superseded (by a recontract) or Ended. Source of truth for the terms; the Order carries a read-only copy. Carried over to the new order on a home move.
+ *
+ * @module OrderModule
+ * @entity Contract
+ * @schemaId 7f5e71ff-040d-4e4e-8e1c-577e623c2319
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+export declare class Contract extends OdinRecord<ContractProperties> {
+    entity: 'OrderModule:Contract';
+    type: ContractEntityTypes;
+    schemaId: '7f5e71ff-040d-4e4e-8e1c-577e623c2319';
+    properties: ContractProperties;
+    /** Linked Order records (Contract__Order) */
+    Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
+    /** Linked Account records (Contract__Account) */
+    Account: OdinLink<LinkedOdinRecord<AccountProperties>>;
+    /** Linked Recontract records (Recontract__Contract) */
+    Recontract: OdinLink<LinkedOdinRecord<RecontractProperties>>;
+}
+/**
+ * RabbitMQ routing keys for Contract events
+ */
+export declare const ROUTING_KEY_CONTRACT_CREATED = "OrderModule.Contract.SubDbRecordCreated";
+export declare const ROUTING_KEY_CONTRACT_UPDATED = "OrderModule.Contract.SubDbRecordUpdated";
+export declare const ROUTING_KEY_CONTRACT_DELETED = "OrderModule.Contract.SubDbRecordDeleted";
+/**
+ * Type-specific routing keys for Contract events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+export declare const ROUTING_KEY_CONTRACT_DEFAULT_CREATED = "OrderModule.Contract.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_CONTRACT_DEFAULT_UPDATED = "OrderModule.Contract.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_CONTRACT_DEFAULT_DELETED = "OrderModule.Contract.DEFAULT.SubDbRecordDeleted";
+/** Event: Contract__Order link created */
+export declare const ROUTING_KEY_LINK_CONTRACT_ORDER_CREATED = "OrderModule.Contract.Order.SubDbRecordAssociationCreated";
+/** Event: Contract__Order link deleted */
+export declare const ROUTING_KEY_LINK_CONTRACT_ORDER_DELETED = "OrderModule.Contract.Order.SubDbRecordAssociationDeleted";
+/** Event: Contract__Account link created */
+export declare const ROUTING_KEY_LINK_CONTRACT_ACCOUNT_CREATED = "OrderModule.Contract.Account.SubDbRecordAssociationCreated";
+/** Event: Contract__Account link deleted */
+export declare const ROUTING_KEY_LINK_CONTRACT_ACCOUNT_DELETED = "OrderModule.Contract.Account.SubDbRecordAssociationDeleted";

package/dist/entities-v2/Contract.js

@@ -0,0 +1,198 @@
+"use strict";
+/**
+ * Contract Entity Definition
+ *
+ * The contract an order runs on: its number, its terms, and whether it is Active, Superseded (by a recontract) or Ended. Source of truth for the terms; the Order carries a read-only copy. Carried over to the new order on a home move.
+ *
+ * @module OrderModule
+ * @entity Contract
+ * @schemaId 7f5e71ff-040d-4e4e-8e1c-577e623c2319
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_LINK_CONTRACT_ACCOUNT_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_ACCOUNT_CREATED = exports.ROUTING_KEY_LINK_CONTRACT_ORDER_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_ORDER_CREATED = exports.ROUTING_KEY_CONTRACT_DEFAULT_DELETED = exports.ROUTING_KEY_CONTRACT_DEFAULT_UPDATED = exports.ROUTING_KEY_CONTRACT_DEFAULT_CREATED = exports.ROUTING_KEY_CONTRACT_DELETED = exports.ROUTING_KEY_CONTRACT_UPDATED = exports.ROUTING_KEY_CONTRACT_CREATED = exports.Contract = exports.ContractPropertyKeys = exports.ContractBillingTerms = exports.ContractContractType = exports.ContractStatus = exports.ContractEntityTypes = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Available types for Contract records
+ */
+var ContractEntityTypes;
+(function (ContractEntityTypes) {
+    /** This is the default record type */
+    ContractEntityTypes["DEFAULT"] = "DEFAULT";
+})(ContractEntityTypes = exports.ContractEntityTypes || (exports.ContractEntityTypes = {}));
+/**
+ * Valid values for Contract.Status
+ *
+ * Active: the contract the order runs on now. Superseded: replaced by a recontract. Ended: the service ended.
+ *
+ * @remarks Available options:
+ * - `ACTIVE` - Active
+ * - `ENDED` - Ended
+ * - `SUPERSEDED` - Superseded
+ */
+var ContractStatus;
+(function (ContractStatus) {
+    ContractStatus["ACTIVE"] = "ACTIVE";
+    ContractStatus["ENDED"] = "ENDED";
+    ContractStatus["SUPERSEDED"] = "SUPERSEDED";
+})(ContractStatus = exports.ContractStatus || (exports.ContractStatus = {}));
+/**
+ * Valid values for Contract.ContractType
+ *
+ * The minimum term. Same options as Order.ContractType.
+ *
+ * @remarks Available options:
+ * - `MONTHLY` - Monthly rolling
+ * - `NONE` - No contract
+ * - `ANNUAL_12` - Term 12 months
+ * - `ANNUAL_18` - Term 18 months
+ * - `ANNUAL_19` - Term 19 months
+ * - `ANNUAL_20` - Term 20 months
+ * - `ANNUAL_21` - Term 21 months
+ * - `ANNUAL_22` - Term 22 months
+ * - `ANNUAL_23` - Term 23 months
+ * - `ANNUAL_24` - Term 24 months
+ * - `ANNUAL_25` - Term 25 months
+ * - `ANNUAL_26` - Term 26 months
+ * - `ANNUAL_27` - Term 27 months
+ * - `ANNUAL_28` - Term 28 months
+ * - `ANNUAL_29` - Term 29 months
+ * - ... and 14 more
+ */
+var ContractContractType;
+(function (ContractContractType) {
+    ContractContractType["MONTHLY_ROLLING"] = "MONTHLY";
+    ContractContractType["NO_CONTRACT"] = "NONE";
+    ContractContractType["TERM_12_MONTHS"] = "ANNUAL_12";
+    ContractContractType["TERM_18_MONTHS"] = "ANNUAL_18";
+    ContractContractType["TERM_19_MONTHS"] = "ANNUAL_19";
+    ContractContractType["TERM_20_MONTHS"] = "ANNUAL_20";
+    ContractContractType["TERM_21_MONTHS"] = "ANNUAL_21";
+    ContractContractType["TERM_22_MONTHS"] = "ANNUAL_22";
+    ContractContractType["TERM_23_MONTHS"] = "ANNUAL_23";
+    ContractContractType["TERM_24_MONTHS"] = "ANNUAL_24";
+    ContractContractType["TERM_25_MONTHS"] = "ANNUAL_25";
+    ContractContractType["TERM_26_MONTHS"] = "ANNUAL_26";
+    ContractContractType["TERM_27_MONTHS"] = "ANNUAL_27";
+    ContractContractType["TERM_28_MONTHS"] = "ANNUAL_28";
+    ContractContractType["TERM_29_MONTHS"] = "ANNUAL_29";
+    ContractContractType["TERM_30_MONTHS"] = "ANNUAL_30";
+    ContractContractType["TERM_31_MONTHS"] = "ANNUAL_31";
+    ContractContractType["TERM_32_MONTHS"] = "ANNUAL_32";
+    ContractContractType["TERM_33_MONTHS"] = "ANNUAL_33";
+    ContractContractType["TERM_34_MONTHS"] = "ANNUAL_34";
+    ContractContractType["TERM_35_MONTHS"] = "ANNUAL_35";
+    ContractContractType["TERM_36_MONTHS"] = "ANNUAL_36";
+    ContractContractType["TERM_37_MONTHS"] = "ANNUAL_37";
+    ContractContractType["TERM_38_MONTHS"] = "ANNUAL_38";
+    ContractContractType["TERM_39_MONTHS"] = "ANNUAL_39";
+    ContractContractType["TERM_40_MONTHS"] = "ANNUAL_40";
+    ContractContractType["TERM_41_MONTHS"] = "ANNUAL_41";
+    ContractContractType["TERM_42_MONTHS"] = "ANNUAL_42";
+    ContractContractType["TERM_60_MONTHS"] = "ANNUAL_60";
+})(ContractContractType = exports.ContractContractType || (exports.ContractContractType = {}));
+/**
+ * Valid values for Contract.BillingTerms
+ *
+ * Payment terms. Same options as Order.BillingTerms.
+ *
+ * @remarks Available options:
+ * - `NET_0` - NET 0
+ * - `NET_10` - NET 10
+ * - `NET_120` - NET 120
+ * - `NET_15` - NET 15
+ * - `NET_3` - NET 3
+ * - `NET_30` - NET 30
+ * - `NET_60` - NET 60
+ * - `NET_90` - NET 90
+ */
+var ContractBillingTerms;
+(function (ContractBillingTerms) {
+    ContractBillingTerms["NET_0"] = "NET_0";
+    ContractBillingTerms["NET_10"] = "NET_10";
+    ContractBillingTerms["NET_120"] = "NET_120";
+    ContractBillingTerms["NET_15"] = "NET_15";
+    ContractBillingTerms["NET_3"] = "NET_3";
+    ContractBillingTerms["NET_30"] = "NET_30";
+    ContractBillingTerms["NET_60"] = "NET_60";
+    ContractBillingTerms["NET_90"] = "NET_90";
+})(ContractBillingTerms = exports.ContractBillingTerms || (exports.ContractBillingTerms = {}));
+/**
+ * Property keys for Contract
+ * Use these constants instead of string literals for type safety
+ */
+var ContractPropertyKeys;
+(function (ContractPropertyKeys) {
+    /** The order's record number for its first contract; each recontract adds -R<n> (OR1849203-R1). Kept across a home move. Unique. */
+    ContractPropertyKeys["ContractNumber"] = "ContractNumber";
+    /** Active: the contract the order runs on now. Superseded: replaced by a recontract. Ended: the service ended. */
+    ContractPropertyKeys["Status"] = "Status";
+    /** The minimum term. Same options as Order.ContractType. */
+    ContractPropertyKeys["ContractType"] = "ContractType";
+    /** The date the contract starts. */
+    ContractPropertyKeys["ContractStartDate"] = "ContractStartDate";
+    /** The date the minimum term ends. */
+    ContractPropertyKeys["ContractEndDate"] = "ContractEndDate";
+    /** How many times the contract has been renewed (recontracted). */
+    ContractPropertyKeys["ContractRenewalCount"] = "ContractRenewalCount";
+    /** The billing anchor. On a home-moved order the order keeps its own (CORE-1492), so this can differ from the order it now runs on. */
+    ContractPropertyKeys["BillingStartDate"] = "BillingStartDate";
+    /** The day of the month the customer is billed. */
+    ContractPropertyKeys["BillingDay"] = "BillingDay";
+    /** The billing day the customer asked for at checkout. */
+    ContractPropertyKeys["DesiredBillingDay"] = "DesiredBillingDay";
+    /** Payment terms. Same options as Order.BillingTerms. */
+    ContractPropertyKeys["BillingTerms"] = "BillingTerms";
+    /** When the recontract that started this contract was applied. */
+    ContractPropertyKeys["RecontractDate"] = "RecontractDate";
+    /** When the terms were last amended. */
+    ContractPropertyKeys["AmendmentDate"] = "AmendmentDate";
+    /** The contract this one superseded, when it was started by a recontract. */
+    ContractPropertyKeys["PreviousContractId"] = "PreviousContractId";
+    /** The order the contract runs on now. The only order its terms are copied to. */
+    ContractPropertyKeys["NextOrderId"] = "NextOrderId";
+    /** The order the contract came from, when it was carried over a home move. Never written to: the terms go to NextOrderId only. */
+    ContractPropertyKeys["PreviousOrderId"] = "PreviousOrderId";
+})(ContractPropertyKeys = exports.ContractPropertyKeys || (exports.ContractPropertyKeys = {}));
+/**
+ * Contract entity from OrderModule
+ *
+ * The contract an order runs on: its number, its terms, and whether it is Active, Superseded (by a recontract) or Ended. Source of truth for the terms; the Order carries a read-only copy. Carried over to the new order on a home move.
+ *
+ * @module OrderModule
+ * @entity Contract
+ * @schemaId 7f5e71ff-040d-4e4e-8e1c-577e623c2319
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+class Contract extends core_1.OdinRecord {
+}
+exports.Contract = Contract;
+// ============================================
+// RABBITMQ EVENT ROUTING KEYS
+// ============================================
+/**
+ * RabbitMQ routing keys for Contract events
+ */
+exports.ROUTING_KEY_CONTRACT_CREATED = 'OrderModule.Contract.SubDbRecordCreated';
+exports.ROUTING_KEY_CONTRACT_UPDATED = 'OrderModule.Contract.SubDbRecordUpdated';
+exports.ROUTING_KEY_CONTRACT_DELETED = 'OrderModule.Contract.SubDbRecordDeleted';
+/**
+ * Type-specific routing keys for Contract events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+exports.ROUTING_KEY_CONTRACT_DEFAULT_CREATED = 'OrderModule.Contract.DEFAULT.SubDbRecordCreated';
+/** This is the default record type updated */
+exports.ROUTING_KEY_CONTRACT_DEFAULT_UPDATED = 'OrderModule.Contract.DEFAULT.SubDbRecordUpdated';
+/** This is the default record type deleted */
+exports.ROUTING_KEY_CONTRACT_DEFAULT_DELETED = 'OrderModule.Contract.DEFAULT.SubDbRecordDeleted';
+/** Event: Contract__Order link created */
+exports.ROUTING_KEY_LINK_CONTRACT_ORDER_CREATED = 'OrderModule.Contract.Order.SubDbRecordAssociationCreated';
+/** Event: Contract__Order link deleted */
+exports.ROUTING_KEY_LINK_CONTRACT_ORDER_DELETED = 'OrderModule.Contract.Order.SubDbRecordAssociationDeleted';
+/** Event: Contract__Account link created */
+exports.ROUTING_KEY_LINK_CONTRACT_ACCOUNT_CREATED = 'OrderModule.Contract.Account.SubDbRecordAssociationCreated';
+/** Event: Contract__Account link deleted */
+exports.ROUTING_KEY_LINK_CONTRACT_ACCOUNT_DELETED = 'OrderModule.Contract.Account.SubDbRecordAssociationDeleted';

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

@@ -35,6 +35,7 @@ export declare enum DocumentProcessingEntityTypes {
  * - `EXTRACT` - Extract text
  * - `OUTCOME_FORM_REVIEW` - Outcome form review
  * - `TEMPLATE_REPORT` - Template report
+ * - `VIEW` - View
  */
 export declare enum DocumentProcessingUseCase {
     CBO_FINAL_BILL_CHECK = "CBO_FINAL_BILL_CHECK",
@@ -45,7 +46,8 @@ export declare enum DocumentProcessingUseCase {
     EXTRACT_FIELDS = "EXTRACT_FIELDS",
     EXTRACT_TEXT = "EXTRACT",
     OUTCOME_FORM_REVIEW = "OUTCOME_FORM_REVIEW",
-    TEMPLATE_REPORT = "TEMPLATE_REPORT"
+    TEMPLATE_REPORT = "TEMPLATE_REPORT",
+    VIEW = "VIEW"
 }
 /**
  * Valid values for DocumentProcessing.Provider

package/dist/entities-v2/DocumentProcessing.js

@@ -37,6 +37,7 @@ var DocumentProcessingEntityTypes;
  * - `EXTRACT` - Extract text
  * - `OUTCOME_FORM_REVIEW` - Outcome form review
  * - `TEMPLATE_REPORT` - Template report
+ * - `VIEW` - View
  */
 var DocumentProcessingUseCase;
 (function (DocumentProcessingUseCase) {
@@ -49,6 +50,7 @@ var DocumentProcessingUseCase;
     DocumentProcessingUseCase["EXTRACT_TEXT"] = "EXTRACT";
     DocumentProcessingUseCase["OUTCOME_FORM_REVIEW"] = "OUTCOME_FORM_REVIEW";
     DocumentProcessingUseCase["TEMPLATE_REPORT"] = "TEMPLATE_REPORT";
+    DocumentProcessingUseCase["VIEW"] = "VIEW";
 })(DocumentProcessingUseCase = exports.DocumentProcessingUseCase || (exports.DocumentProcessingUseCase = {}));
 /**
  * Valid values for DocumentProcessing.Provider

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

@@ -74,6 +74,7 @@ export declare enum DefaultLeadStageKeys {
  *
  * @remarks Available options:
  * - `COMMUNITY_TEAM` - Community team
+ * - `DESKTOP_APP` - Desktop App
  * - `FACEBOOK` - Facebook
  * - `FIELDSALES` - Field sales
  * - `GBVS`
@@ -90,6 +91,7 @@ export declare enum DefaultLeadStageKeys {
  */
 export declare enum LeadSource {
     COMMUNITY_TEAM = "COMMUNITY_TEAM",
+    DESKTOP_APP = "DESKTOP_APP",
     FACEBOOK = "FACEBOOK",
     FIELD_SALES = "FIELDSALES",
     GBVS = "GBVS",

package/dist/entities-v2/Lead.js

@@ -64,6 +64,7 @@ var DefaultLeadStageKeys;
  *
  * @remarks Available options:
  * - `COMMUNITY_TEAM` - Community team
+ * - `DESKTOP_APP` - Desktop App
  * - `FACEBOOK` - Facebook
  * - `FIELDSALES` - Field sales
  * - `GBVS`
@@ -81,6 +82,7 @@ var DefaultLeadStageKeys;
 var LeadSource;
 (function (LeadSource) {
     LeadSource["COMMUNITY_TEAM"] = "COMMUNITY_TEAM";
+    LeadSource["DESKTOP_APP"] = "DESKTOP_APP";
     LeadSource["FACEBOOK"] = "FACEBOOK";
     LeadSource["FIELD_SALES"] = "FIELDSALES";
     LeadSource["GBVS"] = "GBVS";

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

@@ -53,6 +53,7 @@ import { WorkOrderProperties } from './WorkOrder';
 import { EmailProperties } from './Email';
 import { CommitmentProperties } from './Commitment';
 import { HomeMoveProperties } from './HomeMove';
+import { ContractProperties } from './Contract';
 /**
  * Available types for Order records
  */
@@ -616,7 +617,9 @@ export declare enum OrderPropertyKeys {
     /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle. */
     EarliestDueAt = "EarliestDueAt",
     /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493). */
-    RouterUpgradeDeclined = "RouterUpgradeDeclined"
+    RouterUpgradeDeclined = "RouterUpgradeDeclined",
+    /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does. */
+    FirstRequestedActivationDate = "FirstRequestedActivationDate"
 }
 /**
  * Properties for Order records
@@ -1305,6 +1308,12 @@ export interface OrderProperties {
      * @default
      */
     RouterUpgradeDeclined: boolean;
+    /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does.
+     *
+     * @type {DATE}
+     * @default
+     */
+    FirstRequestedActivationDate: string;
 }
 /**
  * Order entity from OrderModule
@@ -1409,6 +1418,8 @@ export declare class Order extends OdinRecord<OrderProperties> {
     Commitment: OdinLink<LinkedOdinRecord<CommitmentProperties>>;
     /** Linked HomeMove records (HomeMove__OldOrder) */
     HomeMove: OdinLink<LinkedOdinRecord<HomeMoveProperties>>;
+    /** Linked Contract records (Contract__Order) */
+    Contract: OdinLink<LinkedOdinRecord<ContractProperties>>;
 }
 /**
  * RabbitMQ routing keys for Order events

package/dist/entities-v2/Order.js

@@ -600,6 +600,8 @@ var OrderPropertyKeys;
     OrderPropertyKeys["EarliestDueAt"] = "EarliestDueAt";
     /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493). */
     OrderPropertyKeys["RouterUpgradeDeclined"] = "RouterUpgradeDeclined";
+    /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does. */
+    OrderPropertyKeys["FirstRequestedActivationDate"] = "FirstRequestedActivationDate";
 })(OrderPropertyKeys = exports.OrderPropertyKeys || (exports.OrderPropertyKeys = {}));
 /**
  * Order entity from OrderModule

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

@@ -13,6 +13,7 @@
 import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
 import { OrderProperties } from './Order';
 import { ModifyServiceRequestProperties } from './ModifyServiceRequest';
+import { ContractProperties } from './Contract';
 /**
  * Available types for Recontract records
  */
@@ -131,7 +132,9 @@ export declare enum RecontractPropertyKeys {
     /** Whether the server determined, at this recontract, that the customer could be offered the choice to skip the router/mesh upgrade (no ONT swap, not a mesh quantity increase). Caller-supplied, forwarded verbatim onto the Recontract record — recontracting itself derives no hardware requirement from this (ORD-493). */
     RouterUpgradeDeclineEligible = "RouterUpgradeDeclineEligible",
     /** What the customer chose at this recontract, when offered the choice above. Caller-supplied, forwarded verbatim — a permanent snapshot, unlike the live Order.RouterUpgradeDeclined, which an agent can flip back on reversal (ORD-493). */
-    RouterUpgradeDeclined = "RouterUpgradeDeclined"
+    RouterUpgradeDeclined = "RouterUpgradeDeclined",
+    /** The contract this recontract started (its -R<n> number). */
+    ContractId = "ContractId"
 }
 /**
  * Properties for Recontract records
@@ -261,6 +264,12 @@ export interface RecontractProperties {
      * @default
      */
     RouterUpgradeDeclined: boolean;
+    /** The contract this recontract started (its -R<n> number).
+     *
+     * @type {LOOKUP}
+     * @default
+     */
+    ContractId: string;
 }
 /**
  * Recontract entity from OrderModule
@@ -282,6 +291,8 @@ export declare class Recontract extends OdinRecord<RecontractProperties> {
     Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
     /** Linked ModifyServiceRequest records (Recontract__ModifyServiceRequest) */
     ModifyServiceRequest: OdinLink<LinkedOdinRecord<ModifyServiceRequestProperties>>;
+    /** Linked Contract records (Recontract__Contract) */
+    Contract: OdinLink<LinkedOdinRecord<ContractProperties>>;
 }
 /**
  * RabbitMQ routing keys for Recontract events
@@ -307,3 +318,7 @@ export declare const ROUTING_KEY_LINK_RECONTRACT_ORDER_DELETED = "OrderModule.Re
 export declare const ROUTING_KEY_LINK_RECONTRACT_MODIFY_SERVICE_REQUEST_CREATED = "OrderModule.Recontract.ModifyServiceRequest.SubDbRecordAssociationCreated";
 /** Event: Recontract__ModifyServiceRequest link deleted */
 export declare const ROUTING_KEY_LINK_RECONTRACT_MODIFY_SERVICE_REQUEST_DELETED = "OrderModule.Recontract.ModifyServiceRequest.SubDbRecordAssociationDeleted";
+/** Event: Recontract__Contract link created */
+export declare const ROUTING_KEY_LINK_RECONTRACT_CONTRACT_CREATED = "OrderModule.Recontract.Contract.SubDbRecordAssociationCreated";
+/** Event: Recontract__Contract link deleted */
+export declare const ROUTING_KEY_LINK_RECONTRACT_CONTRACT_DELETED = "OrderModule.Recontract.Contract.SubDbRecordAssociationDeleted";