@d19n/youfibre-odin-sdk 1.0.232 → 1.0.234

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

@@ -14,8 +14,8 @@ import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/di
 /**
  * Properties for CreateRecontractOrder action
  *
- * @property Required fields: 10
- * @property Optional fields: 3
+ * @property Required fields: 8
+ * @property Optional fields: 4
  */
 export interface CreateRecontractOrderProperties {
     /**
@@ -86,22 +86,6 @@ export interface CreateRecontractOrderProperties {
      * @required
      */
     BillingTerms: string;
-    /**
-     * UDPRN
-     *
-     * unique delivery point reference number
-     * @type {NUMBER}
-     * @required
-     */
-    Udprn: number;
-    /**
-     * UMPRN
-     *
-     * unique multiple point reference number
-     * @type {NUMBER}
-     * @required
-     */
-    Umprn: number;
     /**
      * Source
      *
@@ -123,6 +107,13 @@ export interface CreateRecontractOrderProperties {
      * @type {ENUM}
      */
     Provider?: string;
+    /**
+     * CurrencyCode
+     *
+     * Currency code
+     * @type {ENUM}
+     */
+    CurrencyCode?: string;
 }
 /**
  * CreateRecontractOrder

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

@@ -71,18 +71,18 @@ export declare enum CreditNoteReason {
  * Use these constants instead of string literals for type safety
  */
 export declare enum CreditNotePropertyKeys {
-    /** amount of the credit note */
-    Amount = "Amount",
     /** description of the credit note */
     Description = "Description",
+    /** amount of the credit note */
+    Amount = "Amount",
+    /** credit note status */
+    Status = "Status",
     /** the record # of the invoice */
     InvoiceRef = "InvoiceRef",
-    /** credit note reason */
-    Reason = "Reason",
     /** reason code */
     ReasonCode = "ReasonCode",
-    /** credit note status */
-    Status = "Status"
+    /** credit note reason */
+    Reason = "Reason"
 }
 /**
  * Properties for CreditNote records
@@ -90,40 +90,40 @@ export declare enum CreditNotePropertyKeys {
  * @see BillingModule:CreditNote
  */
 export interface CreditNoteProperties {
+    /** description of the credit note
+     *
+     * @type {TEXT_LONG}
+     */
+    Description?: string;
     /** amount of the credit note
      *
      * @type {CURRENCY}
      * @default 0
      */
     Amount?: string;
-    /** description of the credit note
+    /** credit note status
      *
-     * @type {TEXT_LONG}
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
      */
-    Description?: string;
+    Status?: string;
     /** the record # of the invoice
      *
      * @type {TEXT}
      */
     InvoiceRef?: string;
-    /** credit note reason
-     *
-     * @type {ENUM}
-     * @enum {CreditNoteReason}
-     */
-    Reason?: CreditNoteReason;
     /** reason code
      *
      * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
     ReasonCode?: string;
-    /** credit note status
+    /** credit note reason
      *
-     * @type {TEXT}
-     * @hidden This field is hidden in the UI
+     * @type {ENUM}
+     * @enum {CreditNoteReason}
      */
-    Status?: string;
+    Reason?: CreditNoteReason;
 }
 /**
  * CreditNote entity from BillingModule

package/dist/entities-v2/CreditNote.js

@@ -73,18 +73,18 @@ var CreditNoteReason;
  */
 var CreditNotePropertyKeys;
 (function (CreditNotePropertyKeys) {
-    /** amount of the credit note */
-    CreditNotePropertyKeys["Amount"] = "Amount";
     /** description of the credit note */
     CreditNotePropertyKeys["Description"] = "Description";
+    /** amount of the credit note */
+    CreditNotePropertyKeys["Amount"] = "Amount";
+    /** credit note status */
+    CreditNotePropertyKeys["Status"] = "Status";
     /** the record # of the invoice */
     CreditNotePropertyKeys["InvoiceRef"] = "InvoiceRef";
-    /** credit note reason */
-    CreditNotePropertyKeys["Reason"] = "Reason";
     /** reason code */
     CreditNotePropertyKeys["ReasonCode"] = "ReasonCode";
-    /** credit note status */
-    CreditNotePropertyKeys["Status"] = "Status";
+    /** credit note reason */
+    CreditNotePropertyKeys["Reason"] = "Reason";
 })(CreditNotePropertyKeys = exports.CreditNotePropertyKeys || (exports.CreditNotePropertyKeys = {}));
 /**
  * CreditNote entity from BillingModule

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

@@ -348,6 +348,8 @@ export declare enum OrderPropertyKeys {
     BillingTerms = "BillingTerms",
     /** unique multiple point reference number */
     Umprn = "UMPRN",
+    /** Uprn */
+    Uprn = "Uprn",
     /** referral email */
     ReferralEmail = "ReferralEmail",
     /** network provider */
@@ -395,7 +397,6 @@ export interface OrderProperties {
      * @type {ENUM}
      * @default GBP
      * @enum {OrderCurrencyCode}
-     * @hidden This field is hidden in the UI
      */
     CurrencyCode?: OrderCurrencyCode;
     /** Billing start date
@@ -839,6 +840,11 @@ export interface OrderProperties {
      * @default 0
      */
     Umprn?: number;
+    /** Uprn
+     *
+     * @type {NUMBER}
+     */
+    Uprn?: number;
     /** referral email
      *
      * @type {TEXT}

package/dist/entities-v2/Order.js

@@ -330,6 +330,8 @@ var OrderPropertyKeys;
     OrderPropertyKeys["BillingTerms"] = "BillingTerms";
     /** unique multiple point reference number */
     OrderPropertyKeys["Umprn"] = "UMPRN";
+    /** Uprn */
+    OrderPropertyKeys["Uprn"] = "Uprn";
     /** referral email */
     OrderPropertyKeys["ReferralEmail"] = "ReferralEmail";
     /** network provider */

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

@@ -21,52 +21,6 @@ export declare enum OverlayRealA55EntityTypes {
     /** outcome form */
     OUTCOME_FORM = "OUTCOME_FORM"
 }
-/**
- * Valid values for OverlayRealA55.PointBLocation
- *
- * Select
- *
- * @remarks Available options:
- * - `CUSTOMER_PROPERTY` - Customer Property
- * - `CHAMBER` - Chamber
- * - `POLE` - Pole
- */
-export declare enum OverlayRealA55PointBLocation {
-    CUSTOMER_PROPERTY = "CUSTOMER_PROPERTY",
-    CHAMBER = "CHAMBER",
-    POLE = "POLE"
-}
-/**
- * Valid values for OverlayRealA55.ChamberTypePointB
- *
- * Select
- *
- * @remarks Available options:
- * - `JUF2`
- * - `JUF10`
- * - `JRC12` - JRC12 (C/W 2 Lids)
- * - `JRC14` - JRC14 (C/W 3 Lids)
- * - `CW1` - CW1 (C/W Manhole)
- * - `DUCT_MOUTH_AT_PROPERTY` - Duct Mouth at Property
- * - `LOCKED_CHAMBER` - Locked Chamber
- * - `HOLLOW_POLE` - Hollow Pole
- * - `JUF4`
- * - `JUF6`
- * - `M/H`
- */
-export declare enum OverlayRealA55ChamberTypePointB {
-    JUF2 = "JUF2",
-    JUF10 = "JUF10",
-    JRC12_C_W_2_LIDS = "JRC12",
-    JRC14_C_W_3_LIDS = "JRC14",
-    CW1_C_W_MANHOLE = "CW1",
-    DUCT_MOUTH_AT_PROPERTY = "DUCT_MOUTH_AT_PROPERTY",
-    LOCKED_CHAMBER = "LOCKED_CHAMBER",
-    HOLLOW_POLE = "HOLLOW_POLE",
-    JUF4 = "JUF4",
-    JUF6 = "JUF6",
-    M_H = "M/H"
-}
 /**
  * Valid values for OverlayRealA55.OverlayLocation
  *
@@ -80,19 +34,6 @@ export declare enum OverlayRealA55OverlayLocation {
     PRIVATE_LAND = "PRIVATE_LAND",
     PUBLIC_LAND = "PUBLIC_LAND"
 }
-/**
- * Valid values for OverlayRealA55.PointBTobyRequired
- *
- * Select
- *
- * @remarks Available options:
- * - `YES` - Yes
- * - `NO` - No
- */
-export declare enum OverlayRealA55PointBTobyRequired {
-    YES = "YES",
-    NO = "NO"
-}
 /**
  * Valid values for OverlayRealA55.SurfaceType
  *
@@ -152,6 +93,65 @@ export declare enum OverlayRealA55ChamberTypePointA {
     JUF6 = "JUF6",
     M_H = "M/H"
 }
+/**
+ * Valid values for OverlayRealA55.PointBLocation
+ *
+ * Select
+ *
+ * @remarks Available options:
+ * - `CUSTOMER_PROPERTY` - Customer Property
+ * - `CHAMBER` - Chamber
+ * - `POLE` - Pole
+ */
+export declare enum OverlayRealA55PointBLocation {
+    CUSTOMER_PROPERTY = "CUSTOMER_PROPERTY",
+    CHAMBER = "CHAMBER",
+    POLE = "POLE"
+}
+/**
+ * Valid values for OverlayRealA55.ChamberTypePointB
+ *
+ * Select
+ *
+ * @remarks Available options:
+ * - `JUF2`
+ * - `JUF10`
+ * - `JRC12` - JRC12 (C/W 2 Lids)
+ * - `JRC14` - JRC14 (C/W 3 Lids)
+ * - `CW1` - CW1 (C/W Manhole)
+ * - `DUCT_MOUTH_AT_PROPERTY` - Duct Mouth at Property
+ * - `LOCKED_CHAMBER` - Locked Chamber
+ * - `HOLLOW_POLE` - Hollow Pole
+ * - `JUF4`
+ * - `JUF6`
+ * - `M/H`
+ */
+export declare enum OverlayRealA55ChamberTypePointB {
+    JUF2 = "JUF2",
+    JUF10 = "JUF10",
+    JRC12_C_W_2_LIDS = "JRC12",
+    JRC14_C_W_3_LIDS = "JRC14",
+    CW1_C_W_MANHOLE = "CW1",
+    DUCT_MOUTH_AT_PROPERTY = "DUCT_MOUTH_AT_PROPERTY",
+    LOCKED_CHAMBER = "LOCKED_CHAMBER",
+    HOLLOW_POLE = "HOLLOW_POLE",
+    JUF4 = "JUF4",
+    JUF6 = "JUF6",
+    M_H = "M/H"
+}
+/**
+ * Valid values for OverlayRealA55.PointBTobyRequired
+ *
+ * Select
+ *
+ * @remarks Available options:
+ * - `YES` - Yes
+ * - `NO` - No
+ */
+export declare enum OverlayRealA55PointBTobyRequired {
+    YES = "YES",
+    NO = "NO"
+}
 /**
  * Valid values for OverlayRealA55.MinimumFootwayDistanceMaintained
  *
@@ -204,38 +204,30 @@ export declare enum OverlayRealA55PropertyKeys {
     ExchangeName = "ExchangeName",
     /** Engineer Name */
     EngineerName = "EngineerName",
-    /** Select */
-    PointBLocation = "PointBLocation",
-    /** Select */
-    ChamberTypePointB = "ChamberTypePointB",
-    /** Overlay Details */
-    OverlayDetails = "OverlayDetails",
-    /** Select */
-    OverlayLocation = "OverlayLocation",
-    /** Write here */
-    HowMuchOverlayRequired = "HowMuchOverlayRequired",
-    /** Add image */
-    OverlayRequiredPerspectiveViewPicture = "OverlayRequiredPerspectiveViewPicture",
-    /** Select */
-    PointBTobyRequired = "PointBTobyRequired",
-    /** Add image */
-    PointBTobyLocation = "PointBTobyLocation",
-    /** Add image */
-    NetomniaOdinImageSuggestedRoute = "NetomniaOdinImageSuggestedRoute",
-    /** Write here */
-    Udprn = "UDPRN",
     /** Enter */
     WorkOrderNumber = "WorkOrderNumber",
     /** Write here */
     FullAddress = "FullAddress",
     /** Write here */
     PianoiNumber = "PIANOINumber",
+    /** Write here */
+    Udprn = "UDPRN",
+    /** Overlay Details */
+    OverlayDetails = "OverlayDetails",
+    /** Select */
+    OverlayLocation = "OverlayLocation",
     /** Select */
     SurfaceType = "SurfaceType",
+    /** Write here */
+    HowMuchOverlayRequired = "HowMuchOverlayRequired",
+    /** Add image */
+    OverlayRequiredPerspectiveViewPicture = "OverlayRequiredPerspectiveViewPicture",
     /** Point A Details */
     PointADetails = "PointADetails",
     /** Select */
     PointALocation = "PointALocation",
+    /** Select */
+    ChamberTypePointA = "ChamberTypePointA",
     /** Add image */
     PointAImageSurrounding = "PointAImageSurrounding",
     /** Add image */
@@ -247,13 +239,21 @@ export declare enum OverlayRealA55PropertyKeys {
     /** Point B Details */
     PointBDetails = "PointBDetails",
     /** Select */
-    ChamberTypePointA = "ChamberTypePointA",
+    PointBLocation = "PointBLocation",
+    /** Select */
+    ChamberTypePointB = "ChamberTypePointB",
+    /** Select */
+    PointBTobyRequired = "PointBTobyRequired",
+    /** Add image */
+    PointBTobyLocation = "PointBTobyLocation",
     /** text */
     FurtherDetails = "FurtherDetails",
     /** Select */
     MinimumFootwayDistanceMaintained = "MinimumFootwayDistanceMaintained",
     /** Select */
     CarriagewayIncursionRequired = "CarriagewayIncursionRequired",
+    /** Add image */
+    NetomniaOdinImageSuggestedRoute = "NetomniaOdinImageSuggestedRoute",
     /** Customer Information */
     CustomerInformation = "CustomerInformation",
     /** Select */
@@ -287,18 +287,26 @@ export interface OverlayRealA55Properties {
      * @type {TEXT}
      */
     EngineerName?: string;
-    /** Select
+    /** Enter
      *
-     * @type {ENUM}
-     * @enum {OverlayRealA55PointBLocation}
+     * @type {TEXT}
      */
-    PointBLocation?: OverlayRealA55PointBLocation;
-    /** Select
+    WorkOrderNumber?: string;
+    /** Write here
      *
-     * @type {ENUM}
-     * @enum {OverlayRealA55ChamberTypePointB}
+     * @type {TEXT}
      */
-    ChamberTypePointB?: OverlayRealA55ChamberTypePointB;
+    FullAddress?: string;
+    /** Write here
+     *
+     * @type {TEXT}
+     */
+    PianoiNumber?: string;
+    /** Write here
+     *
+     * @type {TEXT}
+     */
+    Udprn?: string;
     /** Overlay Details
      *
      * @type {TEXT}
@@ -310,58 +318,22 @@ export interface OverlayRealA55Properties {
      * @enum {OverlayRealA55OverlayLocation}
      */
     OverlayLocation?: OverlayRealA55OverlayLocation;
-    /** Write here
-     *
-     * @type {NUMBER}
-     */
-    HowMuchOverlayRequired?: number;
-    /** Add image
-     *
-     * @type {FILE_MULTIPLE}
-     */
-    OverlayRequiredPerspectiveViewPicture?: string;
     /** Select
      *
      * @type {ENUM}
-     * @enum {OverlayRealA55PointBTobyRequired}
+     * @enum {OverlayRealA55SurfaceType}
      */
-    PointBTobyRequired?: OverlayRealA55PointBTobyRequired;
-    /** Add image
+    SurfaceType?: OverlayRealA55SurfaceType;
+    /** Write here
      *
-     * @type {FILE_MULTIPLE}
+     * @type {NUMBER}
      */
-    PointBTobyLocation?: string;
+    HowMuchOverlayRequired?: number;
     /** Add image
      *
      * @type {FILE_MULTIPLE}
      */
-    NetomniaOdinImageSuggestedRoute?: string;
-    /** Write here
-     *
-     * @type {TEXT}
-     */
-    Udprn?: string;
-    /** Enter
-     *
-     * @type {TEXT}
-     */
-    WorkOrderNumber?: string;
-    /** Write here
-     *
-     * @type {TEXT}
-     */
-    FullAddress?: string;
-    /** Write here
-     *
-     * @type {TEXT}
-     */
-    PianoiNumber?: string;
-    /** Select
-     *
-     * @type {ENUM}
-     * @enum {OverlayRealA55SurfaceType}
-     */
-    SurfaceType?: OverlayRealA55SurfaceType;
+    OverlayRequiredPerspectiveViewPicture?: string;
     /** Point A Details
      *
      * @type {TEXT}
@@ -373,6 +345,12 @@ export interface OverlayRealA55Properties {
      * @enum {OverlayRealA55PointALocation}
      */
     PointALocation?: OverlayRealA55PointALocation;
+    /** Select
+     *
+     * @type {ENUM}
+     * @enum {OverlayRealA55ChamberTypePointA}
+     */
+    ChamberTypePointA?: OverlayRealA55ChamberTypePointA;
     /** Add image
      *
      * @type {FILE_MULTIPLE}
@@ -401,9 +379,26 @@ export interface OverlayRealA55Properties {
     /** Select
      *
      * @type {ENUM}
-     * @enum {OverlayRealA55ChamberTypePointA}
+     * @enum {OverlayRealA55PointBLocation}
      */
-    ChamberTypePointA?: OverlayRealA55ChamberTypePointA;
+    PointBLocation?: OverlayRealA55PointBLocation;
+    /** Select
+     *
+     * @type {ENUM}
+     * @enum {OverlayRealA55ChamberTypePointB}
+     */
+    ChamberTypePointB?: OverlayRealA55ChamberTypePointB;
+    /** Select
+     *
+     * @type {ENUM}
+     * @enum {OverlayRealA55PointBTobyRequired}
+     */
+    PointBTobyRequired?: OverlayRealA55PointBTobyRequired;
+    /** Add image
+     *
+     * @type {FILE_MULTIPLE}
+     */
+    PointBTobyLocation?: string;
     /** text
      *
      * @type {TEXT}
@@ -421,6 +416,11 @@ export interface OverlayRealA55Properties {
      * @enum {OverlayRealA55CarriagewayIncursionRequired}
      */
     CarriagewayIncursionRequired?: OverlayRealA55CarriagewayIncursionRequired;
+    /** Add image
+     *
+     * @type {FILE_MULTIPLE}
+     */
+    NetomniaOdinImageSuggestedRoute?: string;
     /** Customer Information
      *
      * @type {TEXT}