@d19n/youfibre-odin-sdk 2.0.65 → 2.0.67

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

@@ -5,19 +5,19 @@
  *
  * @module OrderModule
  * @entity ChurnRequest
- * @schemaId aec13a3b-3a34-43aa-9cc9-dcf8c1637ab6
+ * @schemaId c03f6267-2991-434c-b86e-dc41b485585a
  *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  * Generated from Odin schema definition
  */
 import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
-import { NoteProperties } from './Note';
 import { OrderProperties } from './Order';
+import { NoteProperties } from './Note';
 /**
  * Available types for ChurnRequest records
  */
 export declare enum ChurnRequestEntityTypes {
-    /** This is the default record type */
+    /** Default */
     DEFAULT = "DEFAULT"
 }
 /**
@@ -51,26 +51,26 @@ export declare enum DefaultChurnRequestStageKeys {
  * Gaining Provider
  *
  * @remarks Available options:
- * - `BT`
+ * - `VIRGIN` - Virgin
  * - `EE`
+ * - `VODAFONE` - Vodafone
+ * - `TALKTALK` - TalkTalk
  * - `PLUSNET` - Plusnet
  * - `SKY` - Sky
- * - `TALKTALK` - TalkTalk
  * - `THREE` - Three
+ * - `BT`
  * - `UNABLE_TO_CAPTURE` - Unable to Capture
- * - `VIRGIN` - Virgin
- * - `VODAFONE` - Vodafone
  */
 export declare enum ChurnRequestGainingProvider {
-    BT = "BT",
+    VIRGIN = "VIRGIN",
     EE = "EE",
+    VODAFONE = "VODAFONE",
+    TALK_TALK = "TALKTALK",
     PLUSNET = "PLUSNET",
     SKY = "SKY",
-    TALK_TALK = "TALKTALK",
     THREE = "THREE",
-    UNABLE_TO_CAPTURE = "UNABLE_TO_CAPTURE",
-    VIRGIN = "VIRGIN",
-    VODAFONE = "VODAFONE"
+    BT = "BT",
+    UNABLE_TO_CAPTURE = "UNABLE_TO_CAPTURE"
 }
 /**
  * Valid values for ChurnRequest.Outcome
@@ -91,34 +91,34 @@ export declare enum ChurnRequestOutcome {
  * The reason the customer wants to cancel (Sales - ChurnRequest)
  *
  * @remarks Available options:
- * - `BILLING` - Billing
  * - `CONTRACT_RENEWAL` - Contract Renewal
- * - `CUSTOMER_SERVICE` - Customer Service
+ * - `TRANSFER_OF_OWNERSHIP` - Transfer of Ownership
  * - `DECEASED` - Deceased
- * - `DUPLICATE` - Duplicate
+ * - `BILLING` - Billing
+ * - `CUSTOMER_SERVICE` - Customer Service
  * - `SALES_LOST_TO_COMPETITION` - Sales (Lost to Competition)
  * - `SALES_MISSELLING` - Sales (Misselling)
  * - `SALES_MOVE_OUT` - Sales (Move-Out)
- * - `SALES_MOVE_OUT_IN_AREA` - Sales Move Out (In Area)
  * - `SALES_TRIAL` - Sales (Trial)
  * - `TECHNICAL_ISSUE_NETOMNIA` - Technical Issue (Netomnia)
  * - `TECHNICAL_ISSUE_YOUFIBRE` - Technical Issue (YouFibre)
- * - `TRANSFER_OF_OWNERSHIP` - Transfer of Ownership
+ * - `SALES_MOVE_OUT_IN_AREA` - Sales Move Out (In Area)
+ * - `DUPLICATE` - Duplicate
  */
 export declare enum ChurnRequestReason {
-    BILLING = "BILLING",
     CONTRACT_RENEWAL = "CONTRACT_RENEWAL",
-    CUSTOMER_SERVICE = "CUSTOMER_SERVICE",
+    TRANSFER_OF_OWNERSHIP = "TRANSFER_OF_OWNERSHIP",
     DECEASED = "DECEASED",
-    DUPLICATE = "DUPLICATE",
+    BILLING = "BILLING",
+    CUSTOMER_SERVICE = "CUSTOMER_SERVICE",
     SALES_LOST_TO_COMPETITION = "SALES_LOST_TO_COMPETITION",
     SALES_MISSELLING = "SALES_MISSELLING",
     SALES_MOVE_OUT = "SALES_MOVE_OUT",
-    SALES_MOVE_OUT_IN_AREA = "SALES_MOVE_OUT_IN_AREA",
     SALES_TRIAL = "SALES_TRIAL",
     TECHNICAL_ISSUE_NETOMNIA = "TECHNICAL_ISSUE_NETOMNIA",
     TECHNICAL_ISSUE_YOU_FIBRE = "TECHNICAL_ISSUE_YOUFIBRE",
-    TRANSFER_OF_OWNERSHIP = "TRANSFER_OF_OWNERSHIP"
+    SALES_MOVE_OUT_IN_AREA = "SALES_MOVE_OUT_IN_AREA",
+    DUPLICATE = "DUPLICATE"
 }
 /**
  * Property keys for ChurnRequest
@@ -131,8 +131,6 @@ export declare enum ChurnRequestPropertyKeys {
     GainingProvider = "GainingProvider",
     /** Free-text notes field for ChurnRequest. Used by Sales team for documentation. */
     Comment = "Comment",
-    /** Contact information field for ChurnRequest. Used by Sales team for communication. */
-    Address = "Address",
     /** the user that moved the record to done (Sales - ChurnRequest) */
     CompletedBy = "CompletedBy",
     /** Data field for ChurnRequest records. Used by Sales team. */
@@ -140,7 +138,9 @@ export declare enum ChurnRequestPropertyKeys {
     /** The reason the customer wants to cancel (Sales - ChurnRequest) */
     Reason = "Reason",
     /** the date the record was moved to done (Sales - ChurnRequest) */
-    CompletedDate = "CompletedDate"
+    CompletedDate = "CompletedDate",
+    /** Contact information field for ChurnRequest. Used by Sales team for communication. */
+    Address = "Address"
 }
 /**
  * Properties for ChurnRequest records
@@ -164,11 +164,6 @@ export interface ChurnRequestProperties {
      * @type {TEXT_LONG}
      */
     Comment: string;
-    /** Contact information field for ChurnRequest. Used by Sales team for communication.
-     *
-     * @type {TEXT}
-     */
-    Address: string;
     /** the user that moved the record to done (Sales - ChurnRequest)
      *
      * @type {TEXT}
@@ -194,6 +189,11 @@ export interface ChurnRequestProperties {
      * @hidden This field is hidden in the UI
      */
     CompletedDate: string;
+    /** Contact information field for ChurnRequest. Used by Sales team for communication.
+     *
+     * @type {TEXT}
+     */
+    Address: string;
 }
 /**
  * ChurnRequest entity from OrderModule
@@ -202,19 +202,19 @@ export interface ChurnRequestProperties {
  *
  * @module OrderModule
  * @entity ChurnRequest
- * @schemaId aec13a3b-3a34-43aa-9cc9-dcf8c1637ab6
+ * @schemaId c03f6267-2991-434c-b86e-dc41b485585a
  * @recordPrefix CHREQ
  * @capabilities searchable, updateable, undeletable, triggerable
  */
 export declare class ChurnRequest extends OdinRecord<ChurnRequestProperties> {
     entity: 'OrderModule:ChurnRequest';
     type: ChurnRequestEntityTypes;
-    schemaId: 'aec13a3b-3a34-43aa-9cc9-dcf8c1637ab6';
+    schemaId: 'c03f6267-2991-434c-b86e-dc41b485585a';
     properties: ChurnRequestProperties;
-    /** Linked Note records (ChurnRequest__Note) */
-    Note: OdinLink<LinkedOdinRecord<NoteProperties>>;
     /** Linked Order records (ChurnRequest__Order) */
     Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
+    /** Linked Note records (ChurnRequest__Note) */
+    Note: OdinLink<LinkedOdinRecord<NoteProperties>>;
 }
 /**
  * RabbitMQ routing keys for ChurnRequest events
@@ -226,17 +226,17 @@ export declare const ROUTING_KEY_CHURN_REQUEST_DELETED = "OrderModule.ChurnReque
  * Type-specific routing keys for ChurnRequest events
  * Subscribe to these for events on specific entity types only
  */
-/** This is the default record type created */
+/** Default created */
 export declare const ROUTING_KEY_CHURN_REQUEST_DEFAULT_CREATED = "OrderModule.ChurnRequest.DEFAULT.SubDbRecordCreated";
-/** This is the default record type updated */
+/** Default updated */
 export declare const ROUTING_KEY_CHURN_REQUEST_DEFAULT_UPDATED = "OrderModule.ChurnRequest.DEFAULT.SubDbRecordUpdated";
-/** This is the default record type deleted */
+/** Default deleted */
 export declare const ROUTING_KEY_CHURN_REQUEST_DEFAULT_DELETED = "OrderModule.ChurnRequest.DEFAULT.SubDbRecordDeleted";
-/** Event: ChurnRequest__Note link created */
-export declare const ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_CREATED = "OrderModule.ChurnRequest.Note.SubDbRecordAssociationCreated";
-/** Event: ChurnRequest__Note link deleted */
-export declare const ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_DELETED = "OrderModule.ChurnRequest.Note.SubDbRecordAssociationDeleted";
 /** Event: ChurnRequest__Order link created */
 export declare const ROUTING_KEY_LINK_CHURN_REQUEST_ORDER_CREATED = "OrderModule.ChurnRequest.Order.SubDbRecordAssociationCreated";
 /** Event: ChurnRequest__Order link deleted */
 export declare const ROUTING_KEY_LINK_CHURN_REQUEST_ORDER_DELETED = "OrderModule.ChurnRequest.Order.SubDbRecordAssociationDeleted";
+/** Event: ChurnRequest__Note link created */
+export declare const ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_CREATED = "OrderModule.ChurnRequest.Note.SubDbRecordAssociationCreated";
+/** Event: ChurnRequest__Note link deleted */
+export declare const ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_DELETED = "OrderModule.ChurnRequest.Note.SubDbRecordAssociationDeleted";

package/dist/entities-v2/ChurnRequest.js

@@ -6,20 +6,20 @@
  *
  * @module OrderModule
  * @entity ChurnRequest
- * @schemaId aec13a3b-3a34-43aa-9cc9-dcf8c1637ab6
+ * @schemaId c03f6267-2991-434c-b86e-dc41b485585a
  *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_CHURN_REQUEST_ORDER_DELETED = exports.ROUTING_KEY_LINK_CHURN_REQUEST_ORDER_CREATED = exports.ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_DELETED = exports.ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_CREATED = exports.ROUTING_KEY_CHURN_REQUEST_DEFAULT_DELETED = exports.ROUTING_KEY_CHURN_REQUEST_DEFAULT_UPDATED = exports.ROUTING_KEY_CHURN_REQUEST_DEFAULT_CREATED = exports.ROUTING_KEY_CHURN_REQUEST_DELETED = exports.ROUTING_KEY_CHURN_REQUEST_UPDATED = exports.ROUTING_KEY_CHURN_REQUEST_CREATED = exports.ChurnRequest = exports.ChurnRequestPropertyKeys = exports.ChurnRequestReason = exports.ChurnRequestOutcome = exports.ChurnRequestGainingProvider = exports.DefaultChurnRequestStageKeys = exports.DefaultChurnRequestStageNames = exports.ChurnRequestEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_DELETED = exports.ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_CREATED = exports.ROUTING_KEY_LINK_CHURN_REQUEST_ORDER_DELETED = exports.ROUTING_KEY_LINK_CHURN_REQUEST_ORDER_CREATED = exports.ROUTING_KEY_CHURN_REQUEST_DEFAULT_DELETED = exports.ROUTING_KEY_CHURN_REQUEST_DEFAULT_UPDATED = exports.ROUTING_KEY_CHURN_REQUEST_DEFAULT_CREATED = exports.ROUTING_KEY_CHURN_REQUEST_DELETED = exports.ROUTING_KEY_CHURN_REQUEST_UPDATED = exports.ROUTING_KEY_CHURN_REQUEST_CREATED = exports.ChurnRequest = exports.ChurnRequestPropertyKeys = exports.ChurnRequestReason = exports.ChurnRequestOutcome = exports.ChurnRequestGainingProvider = exports.DefaultChurnRequestStageKeys = exports.DefaultChurnRequestStageNames = exports.ChurnRequestEntityTypes = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for ChurnRequest records
  */
 var ChurnRequestEntityTypes;
 (function (ChurnRequestEntityTypes) {
-    /** This is the default record type */
+    /** Default */
     ChurnRequestEntityTypes["DEFAULT"] = "DEFAULT";
 })(ChurnRequestEntityTypes = exports.ChurnRequestEntityTypes || (exports.ChurnRequestEntityTypes = {}));
 /**
@@ -55,27 +55,27 @@ var DefaultChurnRequestStageKeys;
  * Gaining Provider
  *
  * @remarks Available options:
- * - `BT`
+ * - `VIRGIN` - Virgin
  * - `EE`
+ * - `VODAFONE` - Vodafone
+ * - `TALKTALK` - TalkTalk
  * - `PLUSNET` - Plusnet
  * - `SKY` - Sky
- * - `TALKTALK` - TalkTalk
  * - `THREE` - Three
+ * - `BT`
  * - `UNABLE_TO_CAPTURE` - Unable to Capture
- * - `VIRGIN` - Virgin
- * - `VODAFONE` - Vodafone
  */
 var ChurnRequestGainingProvider;
 (function (ChurnRequestGainingProvider) {
-    ChurnRequestGainingProvider["BT"] = "BT";
+    ChurnRequestGainingProvider["VIRGIN"] = "VIRGIN";
     ChurnRequestGainingProvider["EE"] = "EE";
+    ChurnRequestGainingProvider["VODAFONE"] = "VODAFONE";
+    ChurnRequestGainingProvider["TALK_TALK"] = "TALKTALK";
     ChurnRequestGainingProvider["PLUSNET"] = "PLUSNET";
     ChurnRequestGainingProvider["SKY"] = "SKY";
-    ChurnRequestGainingProvider["TALK_TALK"] = "TALKTALK";
     ChurnRequestGainingProvider["THREE"] = "THREE";
+    ChurnRequestGainingProvider["BT"] = "BT";
     ChurnRequestGainingProvider["UNABLE_TO_CAPTURE"] = "UNABLE_TO_CAPTURE";
-    ChurnRequestGainingProvider["VIRGIN"] = "VIRGIN";
-    ChurnRequestGainingProvider["VODAFONE"] = "VODAFONE";
 })(ChurnRequestGainingProvider = exports.ChurnRequestGainingProvider || (exports.ChurnRequestGainingProvider = {}));
 /**
  * Valid values for ChurnRequest.Outcome
@@ -97,35 +97,35 @@ var ChurnRequestOutcome;
  * The reason the customer wants to cancel (Sales - ChurnRequest)
  *
  * @remarks Available options:
- * - `BILLING` - Billing
  * - `CONTRACT_RENEWAL` - Contract Renewal
- * - `CUSTOMER_SERVICE` - Customer Service
+ * - `TRANSFER_OF_OWNERSHIP` - Transfer of Ownership
  * - `DECEASED` - Deceased
- * - `DUPLICATE` - Duplicate
+ * - `BILLING` - Billing
+ * - `CUSTOMER_SERVICE` - Customer Service
  * - `SALES_LOST_TO_COMPETITION` - Sales (Lost to Competition)
  * - `SALES_MISSELLING` - Sales (Misselling)
  * - `SALES_MOVE_OUT` - Sales (Move-Out)
- * - `SALES_MOVE_OUT_IN_AREA` - Sales Move Out (In Area)
  * - `SALES_TRIAL` - Sales (Trial)
  * - `TECHNICAL_ISSUE_NETOMNIA` - Technical Issue (Netomnia)
  * - `TECHNICAL_ISSUE_YOUFIBRE` - Technical Issue (YouFibre)
- * - `TRANSFER_OF_OWNERSHIP` - Transfer of Ownership
+ * - `SALES_MOVE_OUT_IN_AREA` - Sales Move Out (In Area)
+ * - `DUPLICATE` - Duplicate
  */
 var ChurnRequestReason;
 (function (ChurnRequestReason) {
-    ChurnRequestReason["BILLING"] = "BILLING";
     ChurnRequestReason["CONTRACT_RENEWAL"] = "CONTRACT_RENEWAL";
-    ChurnRequestReason["CUSTOMER_SERVICE"] = "CUSTOMER_SERVICE";
+    ChurnRequestReason["TRANSFER_OF_OWNERSHIP"] = "TRANSFER_OF_OWNERSHIP";
     ChurnRequestReason["DECEASED"] = "DECEASED";
-    ChurnRequestReason["DUPLICATE"] = "DUPLICATE";
+    ChurnRequestReason["BILLING"] = "BILLING";
+    ChurnRequestReason["CUSTOMER_SERVICE"] = "CUSTOMER_SERVICE";
     ChurnRequestReason["SALES_LOST_TO_COMPETITION"] = "SALES_LOST_TO_COMPETITION";
     ChurnRequestReason["SALES_MISSELLING"] = "SALES_MISSELLING";
     ChurnRequestReason["SALES_MOVE_OUT"] = "SALES_MOVE_OUT";
-    ChurnRequestReason["SALES_MOVE_OUT_IN_AREA"] = "SALES_MOVE_OUT_IN_AREA";
     ChurnRequestReason["SALES_TRIAL"] = "SALES_TRIAL";
     ChurnRequestReason["TECHNICAL_ISSUE_NETOMNIA"] = "TECHNICAL_ISSUE_NETOMNIA";
     ChurnRequestReason["TECHNICAL_ISSUE_YOU_FIBRE"] = "TECHNICAL_ISSUE_YOUFIBRE";
-    ChurnRequestReason["TRANSFER_OF_OWNERSHIP"] = "TRANSFER_OF_OWNERSHIP";
+    ChurnRequestReason["SALES_MOVE_OUT_IN_AREA"] = "SALES_MOVE_OUT_IN_AREA";
+    ChurnRequestReason["DUPLICATE"] = "DUPLICATE";
 })(ChurnRequestReason = exports.ChurnRequestReason || (exports.ChurnRequestReason = {}));
 /**
  * Property keys for ChurnRequest
@@ -139,8 +139,6 @@ var ChurnRequestPropertyKeys;
     ChurnRequestPropertyKeys["GainingProvider"] = "GainingProvider";
     /** Free-text notes field for ChurnRequest. Used by Sales team for documentation. */
     ChurnRequestPropertyKeys["Comment"] = "Comment";
-    /** Contact information field for ChurnRequest. Used by Sales team for communication. */
-    ChurnRequestPropertyKeys["Address"] = "Address";
     /** the user that moved the record to done (Sales - ChurnRequest) */
     ChurnRequestPropertyKeys["CompletedBy"] = "CompletedBy";
     /** Data field for ChurnRequest records. Used by Sales team. */
@@ -149,6 +147,8 @@ var ChurnRequestPropertyKeys;
     ChurnRequestPropertyKeys["Reason"] = "Reason";
     /** the date the record was moved to done (Sales - ChurnRequest) */
     ChurnRequestPropertyKeys["CompletedDate"] = "CompletedDate";
+    /** Contact information field for ChurnRequest. Used by Sales team for communication. */
+    ChurnRequestPropertyKeys["Address"] = "Address";
 })(ChurnRequestPropertyKeys = exports.ChurnRequestPropertyKeys || (exports.ChurnRequestPropertyKeys = {}));
 /**
  * ChurnRequest entity from OrderModule
@@ -157,7 +157,7 @@ var ChurnRequestPropertyKeys;
  *
  * @module OrderModule
  * @entity ChurnRequest
- * @schemaId aec13a3b-3a34-43aa-9cc9-dcf8c1637ab6
+ * @schemaId c03f6267-2991-434c-b86e-dc41b485585a
  * @recordPrefix CHREQ
  * @capabilities searchable, updateable, undeletable, triggerable
  */
@@ -177,17 +177,17 @@ exports.ROUTING_KEY_CHURN_REQUEST_DELETED = 'OrderModule.ChurnRequest.SubDbRecor
  * Type-specific routing keys for ChurnRequest events
  * Subscribe to these for events on specific entity types only
  */
-/** This is the default record type created */
+/** Default created */
 exports.ROUTING_KEY_CHURN_REQUEST_DEFAULT_CREATED = 'OrderModule.ChurnRequest.DEFAULT.SubDbRecordCreated';
-/** This is the default record type updated */
+/** Default updated */
 exports.ROUTING_KEY_CHURN_REQUEST_DEFAULT_UPDATED = 'OrderModule.ChurnRequest.DEFAULT.SubDbRecordUpdated';
-/** This is the default record type deleted */
+/** Default deleted */
 exports.ROUTING_KEY_CHURN_REQUEST_DEFAULT_DELETED = 'OrderModule.ChurnRequest.DEFAULT.SubDbRecordDeleted';
-/** Event: ChurnRequest__Note link created */
-exports.ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_CREATED = 'OrderModule.ChurnRequest.Note.SubDbRecordAssociationCreated';
-/** Event: ChurnRequest__Note link deleted */
-exports.ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_DELETED = 'OrderModule.ChurnRequest.Note.SubDbRecordAssociationDeleted';
 /** Event: ChurnRequest__Order link created */
 exports.ROUTING_KEY_LINK_CHURN_REQUEST_ORDER_CREATED = 'OrderModule.ChurnRequest.Order.SubDbRecordAssociationCreated';
 /** Event: ChurnRequest__Order link deleted */
 exports.ROUTING_KEY_LINK_CHURN_REQUEST_ORDER_DELETED = 'OrderModule.ChurnRequest.Order.SubDbRecordAssociationDeleted';
+/** Event: ChurnRequest__Note link created */
+exports.ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_CREATED = 'OrderModule.ChurnRequest.Note.SubDbRecordAssociationCreated';
+/** Event: ChurnRequest__Note link deleted */
+exports.ROUTING_KEY_LINK_CHURN_REQUEST_NOTE_DELETED = 'OrderModule.ChurnRequest.Note.SubDbRecordAssociationDeleted';

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

@@ -5,16 +5,16 @@
  *
  * @module BillingModule
  * @entity Commission
- * @schemaId 79f9709c-9699-46d8-b4c8-82a7f2b25ec9
+ * @schemaId d7d04e9d-9c72-4ebe-b53c-1eaf391d756f
  *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  * Generated from Odin schema definition
  */
 import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
-import { NoteProperties } from './Note';
 import { LeadProperties } from './Lead';
 import { OrderProperties } from './Order';
 import { ContactProperties } from './Contact';
+import { NoteProperties } from './Note';
 /**
  * Available types for Commission records
  */
@@ -28,16 +28,16 @@ export declare enum CommissionEntityTypes {
  * commission status (Finance - Commission)
  *
  * @remarks Available options:
+ * - `WITHHELD` - Withheld
  * - `CLAW_BACK_REQUIRED` - Claw Back Required
  * - `CLAWED_BACK` - Clawed Back
  * - `PAID` - Paid
- * - `WITHHELD` - Withheld
  */
 export declare enum CommissionStatus {
+    WITHHELD = "WITHHELD",
     CLAW_BACK_REQUIRED = "CLAW_BACK_REQUIRED",
     CLAWED_BACK = "CLAWED_BACK",
-    PAID = "PAID",
-    WITHHELD = "WITHHELD"
+    PAID = "PAID"
 }
 /**
  * Valid values for Commission.JobTitle
@@ -63,20 +63,20 @@ export declare enum CommissionJobTitle {
  * Use these constants instead of string literals for type safety
  */
 export declare enum CommissionPropertyKeys {
-    /** date the commission was paid (Finance - Commission) */
-    PaidDate = "PaidDate",
-    /** commission status (Finance - Commission) */
-    Status = "Status",
     /** commission amount (Finance - Commission) */
     Amount = "Amount",
     /** clawed back date (Finance - Commission) */
     ClawedBackDate = "ClawedBackDate",
+    /** date the commission was paid (Finance - Commission) */
+    PaidDate = "PaidDate",
+    /** commission relates to order / lead (Finance - Commission) */
+    RelatesTo = "RelatesTo",
     /** sales agent name (Finance - Commission) */
     Name = "Name",
+    /** commission status (Finance - Commission) */
+    Status = "Status",
     /** commissioner's job title (Finance - Commission) */
-    JobTitle = "JobTitle",
-    /** commission relates to order / lead (Finance - Commission) */
-    RelatesTo = "RelatesTo"
+    JobTitle = "JobTitle"
 }
 /**
  * Properties for Commission records
@@ -84,18 +84,6 @@ export declare enum CommissionPropertyKeys {
  * @see BillingModule:Commission
  */
 export interface CommissionProperties {
-    /** date the commission was paid (Finance - Commission)
-     *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     */
-    PaidDate: string;
-    /** commission status (Finance - Commission)
-     *
-     * @type {ENUM}
-     * @enum {CommissionStatus}
-     */
-    Status: CommissionStatus;
     /** commission amount (Finance - Commission)
      *
      * @type {CURRENCY}
@@ -107,23 +95,35 @@ export interface CommissionProperties {
      * @format DD/MM/YYYY
      */
     ClawedBackDate: string;
+    /** date the commission was paid (Finance - Commission)
+     *
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     */
+    PaidDate: string;
+    /** commission relates to order / lead (Finance - Commission)
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    RelatesTo: string;
     /** sales agent name (Finance - Commission)
      *
      * @type {LOOKUP}
      */
     Name: string;
+    /** commission status (Finance - Commission)
+     *
+     * @type {ENUM}
+     * @enum {CommissionStatus}
+     */
+    Status: CommissionStatus;
     /** commissioner's job title (Finance - Commission)
      *
      * @type {ENUM}
      * @enum {CommissionJobTitle}
      */
     JobTitle: CommissionJobTitle;
-    /** commission relates to order / lead (Finance - Commission)
-     *
-     * @type {TEXT}
-     * @hidden This field is hidden in the UI
-     */
-    RelatesTo: string;
 }
 /**
  * Commission entity from BillingModule
@@ -132,23 +132,23 @@ export interface CommissionProperties {
  *
  * @module BillingModule
  * @entity Commission
- * @schemaId 79f9709c-9699-46d8-b4c8-82a7f2b25ec9
+ * @schemaId d7d04e9d-9c72-4ebe-b53c-1eaf391d756f
  * @menuLabel Commission
  * @capabilities searchable, updateable, undeletable, triggerable
  */
 export declare class Commission extends OdinRecord<CommissionProperties> {
     entity: 'BillingModule:Commission';
     type: CommissionEntityTypes;
-    schemaId: '79f9709c-9699-46d8-b4c8-82a7f2b25ec9';
+    schemaId: 'd7d04e9d-9c72-4ebe-b53c-1eaf391d756f';
     properties: CommissionProperties;
-    /** Linked Note records (Commission__Note) */
-    Note: OdinLink<LinkedOdinRecord<NoteProperties>>;
     /** Linked Lead records (Lead__Commission) */
     Lead: OdinLink<LinkedOdinRecord<LeadProperties>>;
     /** Linked Order records (Order__Commission) */
     Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
     /** Linked Contact records (Commission__Contact) */
     Contact: OdinLink<LinkedOdinRecord<ContactProperties>>;
+    /** Linked Note records (Commission__Note) */
+    Note: OdinLink<LinkedOdinRecord<NoteProperties>>;
 }
 /**
  * RabbitMQ routing keys for Commission events
@@ -166,11 +166,11 @@ export declare const ROUTING_KEY_COMMISSION_DEFAULT_CREATED = "BillingModule.Com
 export declare const ROUTING_KEY_COMMISSION_DEFAULT_UPDATED = "BillingModule.Commission.DEFAULT.SubDbRecordUpdated";
 /** Default record type deleted */
 export declare const ROUTING_KEY_COMMISSION_DEFAULT_DELETED = "BillingModule.Commission.DEFAULT.SubDbRecordDeleted";
-/** Event: Commission__Note link created */
-export declare const ROUTING_KEY_LINK_COMMISSION_NOTE_CREATED = "BillingModule.Commission.Note.SubDbRecordAssociationCreated";
-/** Event: Commission__Note link deleted */
-export declare const ROUTING_KEY_LINK_COMMISSION_NOTE_DELETED = "BillingModule.Commission.Note.SubDbRecordAssociationDeleted";
 /** Event: Commission__Contact link created */
 export declare const ROUTING_KEY_LINK_COMMISSION_CONTACT_CREATED = "BillingModule.Commission.Contact.SubDbRecordAssociationCreated";
 /** Event: Commission__Contact link deleted */
 export declare const ROUTING_KEY_LINK_COMMISSION_CONTACT_DELETED = "BillingModule.Commission.Contact.SubDbRecordAssociationDeleted";
+/** Event: Commission__Note link created */
+export declare const ROUTING_KEY_LINK_COMMISSION_NOTE_CREATED = "BillingModule.Commission.Note.SubDbRecordAssociationCreated";
+/** Event: Commission__Note link deleted */
+export declare const ROUTING_KEY_LINK_COMMISSION_NOTE_DELETED = "BillingModule.Commission.Note.SubDbRecordAssociationDeleted";

package/dist/entities-v2/Commission.js

@@ -6,13 +6,13 @@
  *
  * @module BillingModule
  * @entity Commission
- * @schemaId 79f9709c-9699-46d8-b4c8-82a7f2b25ec9
+ * @schemaId d7d04e9d-9c72-4ebe-b53c-1eaf391d756f
  *
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_COMMISSION_CONTACT_DELETED = exports.ROUTING_KEY_LINK_COMMISSION_CONTACT_CREATED = exports.ROUTING_KEY_LINK_COMMISSION_NOTE_DELETED = exports.ROUTING_KEY_LINK_COMMISSION_NOTE_CREATED = exports.ROUTING_KEY_COMMISSION_DEFAULT_DELETED = exports.ROUTING_KEY_COMMISSION_DEFAULT_UPDATED = exports.ROUTING_KEY_COMMISSION_DEFAULT_CREATED = exports.ROUTING_KEY_COMMISSION_DELETED = exports.ROUTING_KEY_COMMISSION_UPDATED = exports.ROUTING_KEY_COMMISSION_CREATED = exports.Commission = exports.CommissionPropertyKeys = exports.CommissionJobTitle = exports.CommissionStatus = exports.CommissionEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_COMMISSION_NOTE_DELETED = exports.ROUTING_KEY_LINK_COMMISSION_NOTE_CREATED = exports.ROUTING_KEY_LINK_COMMISSION_CONTACT_DELETED = exports.ROUTING_KEY_LINK_COMMISSION_CONTACT_CREATED = exports.ROUTING_KEY_COMMISSION_DEFAULT_DELETED = exports.ROUTING_KEY_COMMISSION_DEFAULT_UPDATED = exports.ROUTING_KEY_COMMISSION_DEFAULT_CREATED = exports.ROUTING_KEY_COMMISSION_DELETED = exports.ROUTING_KEY_COMMISSION_UPDATED = exports.ROUTING_KEY_COMMISSION_CREATED = exports.Commission = exports.CommissionPropertyKeys = exports.CommissionJobTitle = exports.CommissionStatus = exports.CommissionEntityTypes = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for Commission records
@@ -28,17 +28,17 @@ var CommissionEntityTypes;
  * commission status (Finance - Commission)
  *
  * @remarks Available options:
+ * - `WITHHELD` - Withheld
  * - `CLAW_BACK_REQUIRED` - Claw Back Required
  * - `CLAWED_BACK` - Clawed Back
  * - `PAID` - Paid
- * - `WITHHELD` - Withheld
  */
 var CommissionStatus;
 (function (CommissionStatus) {
+    CommissionStatus["WITHHELD"] = "WITHHELD";
     CommissionStatus["CLAW_BACK_REQUIRED"] = "CLAW_BACK_REQUIRED";
     CommissionStatus["CLAWED_BACK"] = "CLAWED_BACK";
     CommissionStatus["PAID"] = "PAID";
-    CommissionStatus["WITHHELD"] = "WITHHELD";
 })(CommissionStatus = exports.CommissionStatus || (exports.CommissionStatus = {}));
 /**
  * Valid values for Commission.JobTitle
@@ -66,20 +66,20 @@ var CommissionJobTitle;
  */
 var CommissionPropertyKeys;
 (function (CommissionPropertyKeys) {
-    /** date the commission was paid (Finance - Commission) */
-    CommissionPropertyKeys["PaidDate"] = "PaidDate";
-    /** commission status (Finance - Commission) */
-    CommissionPropertyKeys["Status"] = "Status";
     /** commission amount (Finance - Commission) */
     CommissionPropertyKeys["Amount"] = "Amount";
     /** clawed back date (Finance - Commission) */
     CommissionPropertyKeys["ClawedBackDate"] = "ClawedBackDate";
+    /** date the commission was paid (Finance - Commission) */
+    CommissionPropertyKeys["PaidDate"] = "PaidDate";
+    /** commission relates to order / lead (Finance - Commission) */
+    CommissionPropertyKeys["RelatesTo"] = "RelatesTo";
     /** sales agent name (Finance - Commission) */
     CommissionPropertyKeys["Name"] = "Name";
+    /** commission status (Finance - Commission) */
+    CommissionPropertyKeys["Status"] = "Status";
     /** commissioner's job title (Finance - Commission) */
     CommissionPropertyKeys["JobTitle"] = "JobTitle";
-    /** commission relates to order / lead (Finance - Commission) */
-    CommissionPropertyKeys["RelatesTo"] = "RelatesTo";
 })(CommissionPropertyKeys = exports.CommissionPropertyKeys || (exports.CommissionPropertyKeys = {}));
 /**
  * Commission entity from BillingModule
@@ -88,7 +88,7 @@ var CommissionPropertyKeys;
  *
  * @module BillingModule
  * @entity Commission
- * @schemaId 79f9709c-9699-46d8-b4c8-82a7f2b25ec9
+ * @schemaId d7d04e9d-9c72-4ebe-b53c-1eaf391d756f
  * @menuLabel Commission
  * @capabilities searchable, updateable, undeletable, triggerable
  */
@@ -114,11 +114,11 @@ exports.ROUTING_KEY_COMMISSION_DEFAULT_CREATED = 'BillingModule.Commission.DEFAU
 exports.ROUTING_KEY_COMMISSION_DEFAULT_UPDATED = 'BillingModule.Commission.DEFAULT.SubDbRecordUpdated';
 /** Default record type deleted */
 exports.ROUTING_KEY_COMMISSION_DEFAULT_DELETED = 'BillingModule.Commission.DEFAULT.SubDbRecordDeleted';
-/** Event: Commission__Note link created */
-exports.ROUTING_KEY_LINK_COMMISSION_NOTE_CREATED = 'BillingModule.Commission.Note.SubDbRecordAssociationCreated';
-/** Event: Commission__Note link deleted */
-exports.ROUTING_KEY_LINK_COMMISSION_NOTE_DELETED = 'BillingModule.Commission.Note.SubDbRecordAssociationDeleted';
 /** Event: Commission__Contact link created */
 exports.ROUTING_KEY_LINK_COMMISSION_CONTACT_CREATED = 'BillingModule.Commission.Contact.SubDbRecordAssociationCreated';
 /** Event: Commission__Contact link deleted */
 exports.ROUTING_KEY_LINK_COMMISSION_CONTACT_DELETED = 'BillingModule.Commission.Contact.SubDbRecordAssociationDeleted';
+/** Event: Commission__Note link created */
+exports.ROUTING_KEY_LINK_COMMISSION_NOTE_CREATED = 'BillingModule.Commission.Note.SubDbRecordAssociationCreated';
+/** Event: Commission__Note link deleted */
+exports.ROUTING_KEY_LINK_COMMISSION_NOTE_DELETED = 'BillingModule.Commission.Note.SubDbRecordAssociationDeleted';