@d19n/youfibre-odin-sdk 2.0.21 → 2.0.22

package/dist/actions-v2/CreateAccountCreditDto.d.ts

@@ -23,7 +23,7 @@ export interface CreateAccountCreditMessage extends OdinRecordCreatedEvent<Creat
  * Properties for CreateAccountCredit action
  *
  * @property Required fields: 3
- * @property Optional fields: 0
+ * @property Optional fields: 3
  */
 export interface CreateAccountCreditProperties {
     /**
@@ -50,6 +50,27 @@ export interface CreateAccountCreditProperties {
      * @required
      */
     CreditBalance: string;
+    /**
+     * Description
+     *
+     * Description
+     * @type {TEXT}
+     */
+    Description?: string | null;
+    /**
+     * Reason
+     *
+     * Reason
+     * @type {ENUM}
+     */
+    Reason?: string | null;
+    /**
+     * Source
+     *
+     * Source
+     * @type {ENUM}
+     */
+    Source?: string | null;
 }
 /**
  * CreateAccountCredit

package/dist/actions-v2/PriceMatchDto.d.ts

@@ -1,5 +1,5 @@
 /**
- * Price Match Action DTO
+ * PriceMatch Action DTO
  *
  * Price match this item with a competitor
  *
@@ -12,16 +12,16 @@
  */
 import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
 /**
- * RabbitMQ message payload for Price Match updated events
+ * RabbitMQ message payload for PriceMatch updated events
  *
  * @event k1.t-hEOJjsDb.OrderModule.OrderItem.Update.PriceMatch
  */
 export interface PriceMatchMessage extends OdinRecordUpdatedEvent<PriceMatchDto, PriceMatchProperties> {
 }
 /**
- * Properties for Price Match action
+ * Properties for PriceMatch action
  *
- * @property Required fields: 2
+ * @property Required fields: 3
  * @property Optional fields: 0
  */
 export interface PriceMatchProperties {
@@ -41,6 +41,14 @@ export interface PriceMatchProperties {
      * @required
      */
     UnitPrice: string;
+    /**
+     * Price Matched To
+     *
+     * PriceMatchedTo
+     * @type {ENUM}
+     * @required
+     */
+    PriceMatchedTo: string;
 }
 /**
  * Price Match

package/dist/actions-v2/PriceMatchDto.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * Price Match Action DTO
+ * PriceMatch Action DTO
  *
  * Price match this item with a competitor
  *

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

@@ -135,8 +135,6 @@ export declare enum EmailPropertyKeys {
     EmailingService = "EmailingService",
     /** The Email Sender related entity */
     EmailSenderId = "EmailSenderId",
-    /** parsed headers */
-    ParsedHeaders = "ParsedHeaders",
     /** WorkOrder */
     WorkOrder = "WorkOrder"
 }
@@ -276,11 +274,6 @@ export interface EmailProperties {
      * @type {LOOKUP}
      */
     EmailSenderId: string;
-    /** parsed headers
-     *
-     * @type {JSON}
-     */
-    ParsedHeaders: string;
     /** WorkOrder
      *
      * @type {LOOKUP}
@@ -423,11 +416,6 @@ export interface ReferralEmailProperties {
      * @type {LOOKUP}
      */
     EmailSenderId: string;
-    /** parsed headers
-     *
-     * @type {JSON}
-     */
-    ParsedHeaders: string;
     /** WorkOrder
      *
      * @type {LOOKUP}
@@ -570,11 +558,6 @@ export interface SupportEmailProperties {
      * @type {LOOKUP}
      */
     EmailSenderId: string;
-    /** parsed headers
-     *
-     * @type {JSON}
-     */
-    ParsedHeaders: string;
     /** WorkOrder
      *
      * @type {LOOKUP}
@@ -717,11 +700,6 @@ export interface TransactionalEmailProperties {
      * @type {LOOKUP}
      */
     EmailSenderId: string;
-    /** parsed headers
-     *
-     * @type {JSON}
-     */
-    ParsedHeaders: string;
     /** WorkOrder
      *
      * @type {LOOKUP}

package/dist/entities-v2/Email.js

@@ -136,8 +136,6 @@ var EmailPropertyKeys;
     EmailPropertyKeys["EmailingService"] = "EmailingService";
     /** The Email Sender related entity */
     EmailPropertyKeys["EmailSenderId"] = "EmailSenderId";
-    /** parsed headers */
-    EmailPropertyKeys["ParsedHeaders"] = "ParsedHeaders";
     /** WorkOrder */
     EmailPropertyKeys["WorkOrder"] = "WorkOrder";
 })(EmailPropertyKeys = exports.EmailPropertyKeys || (exports.EmailPropertyKeys = {}));

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

@@ -131,6 +131,41 @@ export declare enum OrderItemTaxable {
     NO = "NO",
     YES = "YES"
 }
+/**
+ * Valid values for OrderItem.PriceMatchedTo
+ *
+ * PriceMatchedTo
+ *
+ * @remarks Available options:
+ * - `BRSK` - Brsk Reward
+ * - `BT`
+ * - `EE`
+ * - `GRAIN` - Grain
+ * - `LIGHTSPEED` - LightSpeed
+ * - `OTHER` - Other
+ * - `POP_TELECOM` - POP Telecom
+ * - `SKY` - Sky
+ * - `TALKTALK` - TalkTalk
+ * - `THREE` - Three
+ * - `UNKNOWN` - Unknown
+ * - `VIRGIN_MEDIA` - Virgin Media
+ * - `VODAFONE` - Vodafone
+ */
+export declare enum OrderItemPriceMatchedTo {
+    BRSK_REWARD = "BRSK",
+    BT = "BT",
+    EE = "EE",
+    GRAIN = "GRAIN",
+    LIGHT_SPEED = "LIGHTSPEED",
+    OTHER = "OTHER",
+    POP_TELECOM = "POP_TELECOM",
+    SKY = "SKY",
+    TALK_TALK = "TALKTALK",
+    THREE = "THREE",
+    UNKNOWN = "UNKNOWN",
+    VIRGIN_MEDIA = "VIRGIN_MEDIA",
+    VODAFONE = "VODAFONE"
+}
 /**
  * Property keys for OrderItem
  * Use these constants instead of string literals for type safety
@@ -209,7 +244,9 @@ export declare enum OrderItemPropertyKeys {
     /** is the item taxable (Sales - OrderItem) */
     Taxable = "Taxable",
     /** suggested retail price cost + markup (Sales - OrderItem) */
-    UnitPrice = "UnitPrice"
+    UnitPrice = "UnitPrice",
+    /** PriceMatchedTo */
+    PriceMatchedTo = "PriceMatchedTo"
 }
 /**
  * Properties for OrderItem records
@@ -463,6 +500,12 @@ export interface OrderItemProperties {
      * @hidden This field is hidden in the UI
      */
     UnitPrice: string;
+    /** PriceMatchedTo
+     *
+     * @type {ENUM}
+     * @enum {OrderItemPriceMatchedTo}
+     */
+    PriceMatchedTo: OrderItemPriceMatchedTo;
 }
 /**
  * OrderItem entity from OrderModule

package/dist/entities-v2/OrderItem.js

@@ -12,7 +12,7 @@
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_ORDER_ITEM_OFFER_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_OFFER_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_FILE_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_FILE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_PRODUCT_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_PRODUCT_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_PHONE_PORTING_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_PHONE_PORTING_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_ACTIVITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_ACTIVITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ONT_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ONT_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_NOTE_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_NOTE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_VOICE_CONFIGURATION_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_VOICE_CONFIGURATION_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_ORDER_ITEM_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ATA_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ATA_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ROUTER_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ROUTER_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_BNG_PROVISION_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_BNG_PROVISION_CREATED = exports.ROUTING_KEY_ORDER_ITEM_DEFAULT_DELETED = exports.ROUTING_KEY_ORDER_ITEM_DEFAULT_UPDATED = exports.ROUTING_KEY_ORDER_ITEM_DEFAULT_CREATED = exports.ROUTING_KEY_ORDER_ITEM_DELETED = exports.ROUTING_KEY_ORDER_ITEM_UPDATED = exports.ROUTING_KEY_ORDER_ITEM_CREATED = exports.OrderItem = exports.OrderItemPropertyKeys = exports.OrderItemTaxable = exports.OrderItemActivationStatus = exports.OrderItemDiscount2Type = exports.OrderItemBillingPeriodType = exports.OrderItemTaxIncluded = exports.OrderItemAmendmentType = exports.OrderItemDiscountType = exports.OrderItemEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_ORDER_ITEM_OFFER_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_OFFER_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_FILE_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_FILE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_PRODUCT_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_PRODUCT_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_PHONE_PORTING_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_PHONE_PORTING_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_ACTIVITY_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_ACTIVITY_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ONT_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ONT_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_NOTE_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_NOTE_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_VOICE_CONFIGURATION_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_VOICE_CONFIGURATION_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_ORDER_ITEM_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ATA_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ATA_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ROUTER_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_CUSTOMER_DEVICE_ROUTER_CREATED = exports.ROUTING_KEY_LINK_ORDER_ITEM_BNG_PROVISION_DELETED = exports.ROUTING_KEY_LINK_ORDER_ITEM_BNG_PROVISION_CREATED = exports.ROUTING_KEY_ORDER_ITEM_DEFAULT_DELETED = exports.ROUTING_KEY_ORDER_ITEM_DEFAULT_UPDATED = exports.ROUTING_KEY_ORDER_ITEM_DEFAULT_CREATED = exports.ROUTING_KEY_ORDER_ITEM_DELETED = exports.ROUTING_KEY_ORDER_ITEM_UPDATED = exports.ROUTING_KEY_ORDER_ITEM_CREATED = exports.OrderItem = exports.OrderItemPropertyKeys = exports.OrderItemPriceMatchedTo = exports.OrderItemTaxable = exports.OrderItemActivationStatus = exports.OrderItemDiscount2Type = exports.OrderItemBillingPeriodType = exports.OrderItemTaxIncluded = exports.OrderItemAmendmentType = exports.OrderItemDiscountType = exports.OrderItemEntityTypes = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for OrderItem records
@@ -126,6 +126,42 @@ var OrderItemTaxable;
     OrderItemTaxable["NO"] = "NO";
     OrderItemTaxable["YES"] = "YES";
 })(OrderItemTaxable = exports.OrderItemTaxable || (exports.OrderItemTaxable = {}));
+/**
+ * Valid values for OrderItem.PriceMatchedTo
+ *
+ * PriceMatchedTo
+ *
+ * @remarks Available options:
+ * - `BRSK` - Brsk Reward
+ * - `BT`
+ * - `EE`
+ * - `GRAIN` - Grain
+ * - `LIGHTSPEED` - LightSpeed
+ * - `OTHER` - Other
+ * - `POP_TELECOM` - POP Telecom
+ * - `SKY` - Sky
+ * - `TALKTALK` - TalkTalk
+ * - `THREE` - Three
+ * - `UNKNOWN` - Unknown
+ * - `VIRGIN_MEDIA` - Virgin Media
+ * - `VODAFONE` - Vodafone
+ */
+var OrderItemPriceMatchedTo;
+(function (OrderItemPriceMatchedTo) {
+    OrderItemPriceMatchedTo["BRSK_REWARD"] = "BRSK";
+    OrderItemPriceMatchedTo["BT"] = "BT";
+    OrderItemPriceMatchedTo["EE"] = "EE";
+    OrderItemPriceMatchedTo["GRAIN"] = "GRAIN";
+    OrderItemPriceMatchedTo["LIGHT_SPEED"] = "LIGHTSPEED";
+    OrderItemPriceMatchedTo["OTHER"] = "OTHER";
+    OrderItemPriceMatchedTo["POP_TELECOM"] = "POP_TELECOM";
+    OrderItemPriceMatchedTo["SKY"] = "SKY";
+    OrderItemPriceMatchedTo["TALK_TALK"] = "TALKTALK";
+    OrderItemPriceMatchedTo["THREE"] = "THREE";
+    OrderItemPriceMatchedTo["UNKNOWN"] = "UNKNOWN";
+    OrderItemPriceMatchedTo["VIRGIN_MEDIA"] = "VIRGIN_MEDIA";
+    OrderItemPriceMatchedTo["VODAFONE"] = "VODAFONE";
+})(OrderItemPriceMatchedTo = exports.OrderItemPriceMatchedTo || (exports.OrderItemPriceMatchedTo = {}));
 /**
  * Property keys for OrderItem
  * Use these constants instead of string literals for type safety
@@ -206,6 +242,8 @@ var OrderItemPropertyKeys;
     OrderItemPropertyKeys["Taxable"] = "Taxable";
     /** suggested retail price cost + markup (Sales - OrderItem) */
     OrderItemPropertyKeys["UnitPrice"] = "UnitPrice";
+    /** PriceMatchedTo */
+    OrderItemPropertyKeys["PriceMatchedTo"] = "PriceMatchedTo";
 })(OrderItemPropertyKeys = exports.OrderItemPropertyKeys || (exports.OrderItemPropertyKeys = {}));
 /**
  * OrderItem entity from OrderModule

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

@@ -74,26 +74,26 @@ export declare enum PaymentMethodRefundOutcome {
  * Use these constants instead of string literals for type safety
  */
 export declare enum PaymentMethodRefundPropertyKeys {
-    /** Monetary value field for PaymentMethodRefund. Used by Finance team for financial tracking. */
-    Amount = "Amount",
-    /** Authorized By (Finance - PaymentMethodRefund) */
-    AuthorizedBy = "AuthorizedBy",
     /** Reference identifier for PaymentMethodRefund relationships. Used for data integrity. */
     ContactId = "ContactId",
+    /** Work Order Ref (Finance - PaymentMethodRefund) */
+    WorkOrderRef = "WorkOrderRef",
     /** Description (Finance - PaymentMethodRefund) */
     Description = "Description",
+    /** Status indicator for PaymentMethodRefund records. Tracks lifecycle state. Used by Finance team. */
+    Status = "Status",
     /** Reference identifier for PaymentMethodRefund relationships. Used for data integrity. */
     InvoiceRef = "InvoiceRef",
+    /** Monetary value field for PaymentMethodRefund. Used by Finance team for financial tracking. */
+    Amount = "Amount",
     /** Reference identifier for PaymentMethodRefund relationships. Used for data integrity. */
     OrderRef = "OrderRef",
     /** Data field for PaymentMethodRefund records. Used by Finance team. */
     Outcome = "Outcome",
+    /** Authorized By (Finance - PaymentMethodRefund) */
+    AuthorizedBy = "AuthorizedBy",
     /** Reward for which the payment was triggered */
-    RewardRef = "RewardRef",
-    /** Status indicator for PaymentMethodRefund records. Tracks lifecycle state. Used by Finance team. */
-    Status = "Status",
-    /** Work Order Ref (Finance - PaymentMethodRefund) */
-    WorkOrderRef = "WorkOrderRef"
+    RewardRef = "RewardRef"
 }
 /**
  * Properties for PaymentMethodRefund records
@@ -101,32 +101,38 @@ export declare enum PaymentMethodRefundPropertyKeys {
  * @see BillingModule:PaymentMethodRefund
  */
 export interface PaymentMethodRefundProperties {
-    /** Monetary value field for PaymentMethodRefund. Used by Finance team for financial tracking.
-     *
-     * @type {CURRENCY}
-     */
-    Amount: string;
-    /** Authorized By (Finance - PaymentMethodRefund)
-     *
-     * @type {TEXT}
-     */
-    AuthorizedBy: string;
     /** Reference identifier for PaymentMethodRefund relationships. Used for data integrity.
      *
      * @type {LOOKUP}
      * @hidden This field is hidden in the UI
      */
     ContactId: string;
+    /** Work Order Ref (Finance - PaymentMethodRefund)
+     *
+     * @type {LOOKUP}
+     */
+    WorkOrderRef: string;
     /** Description (Finance - PaymentMethodRefund)
      *
      * @type {TEXT}
      */
     Description: string;
+    /** Status indicator for PaymentMethodRefund records. Tracks lifecycle state. Used by Finance team.
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    Status: string;
     /** Reference identifier for PaymentMethodRefund relationships. Used for data integrity.
      *
      * @type {LOOKUP}
      */
     InvoiceRef: string;
+    /** Monetary value field for PaymentMethodRefund. Used by Finance team for financial tracking.
+     *
+     * @type {CURRENCY}
+     */
+    Amount: string;
     /** Reference identifier for PaymentMethodRefund relationships. Used for data integrity.
      *
      * @type {LOOKUP}
@@ -138,22 +144,16 @@ export interface PaymentMethodRefundProperties {
      * @enum {PaymentMethodRefundOutcome}
      */
     Outcome: PaymentMethodRefundOutcome;
-    /** Reward for which the payment was triggered
-     *
-     * @type {LOOKUP}
-     */
-    RewardRef: string;
-    /** Status indicator for PaymentMethodRefund records. Tracks lifecycle state. Used by Finance team.
+    /** Authorized By (Finance - PaymentMethodRefund)
      *
      * @type {TEXT}
-     * @hidden This field is hidden in the UI
      */
-    Status: string;
-    /** Work Order Ref (Finance - PaymentMethodRefund)
+    AuthorizedBy: string;
+    /** Reward for which the payment was triggered
      *
      * @type {LOOKUP}
      */
-    WorkOrderRef: string;
+    RewardRef: string;
 }
 /**
  * PaymentMethodRefund entity from BillingModule

package/dist/entities-v2/PaymentMethodRefund.js

@@ -73,26 +73,26 @@ var PaymentMethodRefundOutcome;
  */
 var PaymentMethodRefundPropertyKeys;
 (function (PaymentMethodRefundPropertyKeys) {
-    /** Monetary value field for PaymentMethodRefund. Used by Finance team for financial tracking. */
-    PaymentMethodRefundPropertyKeys["Amount"] = "Amount";
-    /** Authorized By (Finance - PaymentMethodRefund) */
-    PaymentMethodRefundPropertyKeys["AuthorizedBy"] = "AuthorizedBy";
     /** Reference identifier for PaymentMethodRefund relationships. Used for data integrity. */
     PaymentMethodRefundPropertyKeys["ContactId"] = "ContactId";
+    /** Work Order Ref (Finance - PaymentMethodRefund) */
+    PaymentMethodRefundPropertyKeys["WorkOrderRef"] = "WorkOrderRef";
     /** Description (Finance - PaymentMethodRefund) */
     PaymentMethodRefundPropertyKeys["Description"] = "Description";
+    /** Status indicator for PaymentMethodRefund records. Tracks lifecycle state. Used by Finance team. */
+    PaymentMethodRefundPropertyKeys["Status"] = "Status";
     /** Reference identifier for PaymentMethodRefund relationships. Used for data integrity. */
     PaymentMethodRefundPropertyKeys["InvoiceRef"] = "InvoiceRef";
+    /** Monetary value field for PaymentMethodRefund. Used by Finance team for financial tracking. */
+    PaymentMethodRefundPropertyKeys["Amount"] = "Amount";
     /** Reference identifier for PaymentMethodRefund relationships. Used for data integrity. */
     PaymentMethodRefundPropertyKeys["OrderRef"] = "OrderRef";
     /** Data field for PaymentMethodRefund records. Used by Finance team. */
     PaymentMethodRefundPropertyKeys["Outcome"] = "Outcome";
+    /** Authorized By (Finance - PaymentMethodRefund) */
+    PaymentMethodRefundPropertyKeys["AuthorizedBy"] = "AuthorizedBy";
     /** Reward for which the payment was triggered */
     PaymentMethodRefundPropertyKeys["RewardRef"] = "RewardRef";
-    /** Status indicator for PaymentMethodRefund records. Tracks lifecycle state. Used by Finance team. */
-    PaymentMethodRefundPropertyKeys["Status"] = "Status";
-    /** Work Order Ref (Finance - PaymentMethodRefund) */
-    PaymentMethodRefundPropertyKeys["WorkOrderRef"] = "WorkOrderRef";
 })(PaymentMethodRefundPropertyKeys = exports.PaymentMethodRefundPropertyKeys || (exports.PaymentMethodRefundPropertyKeys = {}));
 /**
  * PaymentMethodRefund entity from BillingModule

package/package.json

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