@d19n/youfibre-odin-sdk 2.0.229 → 2.0.231

package/dist/db-sdk-v2/PgReportEventDb.js

@@ -0,0 +1,216 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PgReportEventDb = void 0;
+const db_provider_1 = require("@d19n/odin-sdk-generator/dist/db.provider");
+const db_record_link_manager_1 = require("@d19n/odin-sdk-generator/dist/db.record.link.manager");
+/**
+ * @deprecated Use OdinDbClient.
+ *
+ * Migration:
+ * - Old: new PgReportEventApi(authParams).get(id)
+ * - New: new odin.pgreportevent.get(id)
+ *
+ * The new OdinDbClient returns typed record wrappers with action methods.
+ *
+ * Supports separate query options and provider options:
+ * - Constructor level: new PgReportEventDb(principal, dbService, { omitPermissionsCheck: true })
+ * - Method level: await db.getByPrimaryKey(id, { entities: [] }, { omitPermissionsCheck: true })
+ */
+class PgReportEventDb extends db_provider_1.DbProvider {
+    constructor(principal, dbService, defaultOptions) {
+        super(principal, dbService, defaultOptions);
+        this.moduleName = 'BillingModule';
+        this.entityName = 'PgReportEvent';
+        this.principal = principal;
+        this.dbService = dbService;
+        // Link managers are lazy-loaded on first access
+    }
+    // ============================================
+    // LAZY-LOADED LINK MANAGERS (Public Getters)
+    // ============================================
+    // Usage remains identical: db.address.list(recordId)
+    get pgdirectdebitfile() {
+        if (!this._pgdirectdebitfile) {
+            this._pgdirectdebitfile = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'BillingModule:PgReportEvent', 'BillingModule:PgDirectDebitFile', 'PgDirectDebitFile__PgReportEvent');
+        }
+        return this._pgdirectdebitfile;
+    }
+    get pgpaymentmethod() {
+        if (!this._pgpaymentmethod) {
+            this._pgpaymentmethod = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'BillingModule:PgReportEvent', 'BillingModule:PgPaymentMethod', 'PgPaymentMethod__PgReportEvent');
+        }
+        return this._pgpaymentmethod;
+    }
+    get pgtransaction() {
+        if (!this._pgtransaction) {
+            this._pgtransaction = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'BillingModule:PgReportEvent', 'BillingModule:PgTransaction', 'PgTransaction__PgReportEvent');
+        }
+        return this._pgtransaction;
+    }
+    // ============================================
+    // STANDARD METHODS
+    // ============================================
+    // Methods support separate query options and provider options for clean API
+    setRecord(sourceRecord) {
+        this.sourceRecord = sourceRecord;
+    }
+    /**
+     * Search records with manual pagination control
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    searchRecords(params, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchRecords(this.moduleName, this.entityName, params, providerOptions);
+        });
+    }
+    /**
+     * Search all records with automatic pagination
+     * @param params - Search parameters
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    searchAllRecordsAndPaginate(params, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._searchAllRecordsAndPaginate(this.moduleName, this.entityName, params, 0, providerOptions);
+        });
+    }
+    /**
+     * Get a single record by primary key
+     * @param pgReportEventId - Record ID
+     * @param queryOptions - Query options (WHAT: entities to include)
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     *
+     * @example
+     * // Simple get
+     * const record = await db.getByPrimaryKey(id);
+     *
+     * // With related entities
+     * const record = await db.getByPrimaryKey(id, { entities: ['InvoiceItem', 'Transaction'] });
+     *
+     * // With permissions bypass
+     * const record = await db.getByPrimaryKey(id, {}, { omitPermissionsCheck: true });
+     *
+     * // Both options
+     * const record = await db.getByPrimaryKey(id, { entities: ['Invoice'] }, { omitPermissionsCheck: true });
+     */
+    getByPrimaryKey(pgReportEventId, queryOptions, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._getByPrimaryKey(this.moduleName, this.entityName, pgReportEventId, queryOptions, providerOptions);
+            if (res)
+                this.setRecord(res);
+            return res;
+        });
+    }
+    /**
+     * Get multiple records by primary keys
+     * @param pgReportEventIds - Array of record IDs
+     * @param queryOptions - Query options (WHAT: entities to include)
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getManyByPrimaryKey(pgReportEventIds, queryOptions, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getManyByPrimaryKey(this.moduleName, this.entityName, pgReportEventIds, queryOptions, providerOptions);
+        });
+    }
+    /**
+     * Upsert a single record
+     * @param upsertDto - Record to upsert
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    upsert(upsertDto, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._upsert(this.moduleName, this.entityName, [upsertDto], providerOptions);
+            return res[0];
+        });
+    }
+    /**
+     * Upsert multiple records
+     * @param upsertDtos - Records to upsert
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    upsertMany(upsertDtos, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._upsert(this.moduleName, this.entityName, upsertDtos, providerOptions);
+        });
+    }
+    /**
+     * Update a single record
+     * @param updateDto - Record to update
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    update(updateDto, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this._update(this.moduleName, this.entityName, [updateDto], providerOptions);
+            return res[0];
+        });
+    }
+    /**
+     * Update multiple records
+     * @param updateDtos - Records to update
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    updateMany(updateDtos, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._update(this.moduleName, this.entityName, updateDtos, providerOptions);
+        });
+    }
+    /**
+     * Delete one or many records
+     * @param pgReportEventIds - Record IDs to delete
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    delete(pgReportEventIds, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._delete(this.moduleName, this.entityName, pgReportEventIds, providerOptions);
+        });
+    }
+    /**
+     * Restore one or many deleted records
+     * @param pgReportEventIds - Record IDs to restore
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    restore(pgReportEventIds, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._restore(this.moduleName, this.entityName, pgReportEventIds, providerOptions);
+        });
+    }
+    /**
+     * Apply an action to a record
+     * @param actionName - The action key
+     * @param dto - The action DTO
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    applyAction(actionName, dto, providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._applyAction(this.moduleName, this.entityName, dto, providerOptions);
+        });
+    }
+    /**
+     * Get version history for the current source record
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getVersions(providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getVersions(this.moduleName, this.entityName, this.sourceRecord.id, providerOptions);
+        });
+    }
+    /**
+     * Get revision timeline for the current source record
+     * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
+     */
+    getRevisionTimeline(providerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this._getRevisionTimeline(this.moduleName, this.entityName, this.sourceRecord.id, providerOptions);
+        });
+    }
+}
+exports.PgReportEventDb = PgReportEventDb;

package/dist/db-sdk-v2/PgTransactionDb.d.ts

@@ -25,11 +25,13 @@ export declare class PgTransactionDb extends DbProvider {
     private _pgpaymentmethod?;
     private _pgdispute?;
     private _pgfileallocation?;
+    private _pgreportevent?;
     constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
     get pgwebhook(): DbRecordLinkManager;
     get pgpaymentmethod(): DbRecordLinkManager;
     get pgdispute(): DbRecordLinkManager;
     get pgfileallocation(): DbRecordLinkManager;
+    get pgreportevent(): DbRecordLinkManager;
     setRecord(sourceRecord: any): void;
     /**
      * Search records with manual pagination control

package/dist/db-sdk-v2/PgTransactionDb.js

@@ -62,6 +62,12 @@ class PgTransactionDb extends db_provider_1.DbProvider {
         }
         return this._pgfileallocation;
     }
+    get pgreportevent() {
+        if (!this._pgreportevent) {
+            this._pgreportevent = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'BillingModule:PgTransaction', 'BillingModule:PgReportEvent', 'PgTransaction__PgReportEvent');
+        }
+        return this._pgreportevent;
+    }
     // ============================================
     // STANDARD METHODS
     // ============================================

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

@@ -97,6 +97,8 @@ export declare enum ChurnRequestOutcome {
  * - `CUSTOMER_SERVICE` - Customer Service
  * - `DECEASED` - Deceased
  * - `DUPLICATE` - Duplicate
+ * - `OTS_LOSS_FAILURE` - OTS Loss Failure
+ * - `OTS_LOSS_SUCCESS` - OTS Loss Success
  * - `SALES_LOST_TO_COMPETITION` - Sales (Lost to Competition)
  * - `SALES_MISSELLING` - Sales (Misselling)
  * - `SALES_MOVE_OUT` - Sales (Move-Out)
@@ -112,6 +114,8 @@ export declare enum ChurnRequestReason {
     CUSTOMER_SERVICE = "CUSTOMER_SERVICE",
     DECEASED = "DECEASED",
     DUPLICATE = "DUPLICATE",
+    OTS_LOSS_FAILURE = "OTS_LOSS_FAILURE",
+    OTS_LOSS_SUCCESS = "OTS_LOSS_SUCCESS",
     SALES_LOST_TO_COMPETITION = "SALES_LOST_TO_COMPETITION",
     SALES_MISSELLING = "SALES_MISSELLING",
     SALES_MOVE_OUT = "SALES_MOVE_OUT",

package/dist/entities-v2/ChurnRequest.js

@@ -102,6 +102,8 @@ var ChurnRequestOutcome;
  * - `CUSTOMER_SERVICE` - Customer Service
  * - `DECEASED` - Deceased
  * - `DUPLICATE` - Duplicate
+ * - `OTS_LOSS_FAILURE` - OTS Loss Failure
+ * - `OTS_LOSS_SUCCESS` - OTS Loss Success
  * - `SALES_LOST_TO_COMPETITION` - Sales (Lost to Competition)
  * - `SALES_MISSELLING` - Sales (Misselling)
  * - `SALES_MOVE_OUT` - Sales (Move-Out)
@@ -118,6 +120,8 @@ var ChurnRequestReason;
     ChurnRequestReason["CUSTOMER_SERVICE"] = "CUSTOMER_SERVICE";
     ChurnRequestReason["DECEASED"] = "DECEASED";
     ChurnRequestReason["DUPLICATE"] = "DUPLICATE";
+    ChurnRequestReason["OTS_LOSS_FAILURE"] = "OTS_LOSS_FAILURE";
+    ChurnRequestReason["OTS_LOSS_SUCCESS"] = "OTS_LOSS_SUCCESS";
     ChurnRequestReason["SALES_LOST_TO_COMPETITION"] = "SALES_LOST_TO_COMPETITION";
     ChurnRequestReason["SALES_MISSELLING"] = "SALES_MISSELLING";
     ChurnRequestReason["SALES_MOVE_OUT"] = "SALES_MOVE_OUT";

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

@@ -81,19 +81,6 @@ export declare enum ContactCurrentProvider {
     VODAFONE = "VODAFONE",
     ZEN = "ZEN"
 }
-/**
- * Valid values for Contact.AdditionalCareConsent
- *
- * Customer consent for recording additional care requiremetns (Sales - Contact)
- *
- * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
- */
-export declare enum ContactAdditionalCareConsent {
-    NO = "NO",
-    YES = "YES"
-}
 /**
  * Valid values for Contact.PortalStatus
  *
@@ -109,21 +96,6 @@ export declare enum ContactPortalStatus {
     INACTIVE = "INACTIVE",
     NONE = "NONE"
 }
-/**
- * Valid values for Contact.HomeownerStatus
- *
- * Homeowner Status (Sales - Contact)
- *
- * @remarks Available options:
- * - `HOMEOWNER` - I own the property
- * - `RENTER` - It is a rented property
- * - `LIVING_WITH_PARENTS` - Living with parents
- */
-export declare enum ContactHomeownerStatus {
-    I_OWN_THE_PROPERTY = "HOMEOWNER",
-    IT_IS_A_RENTED_PROPERTY = "RENTER",
-    LIVING_WITH_PARENTS = "LIVING_WITH_PARENTS"
-}
 /**
  * Valid values for Contact.PreviousProvider
  *
@@ -240,6 +212,19 @@ export declare enum ContactTelecareAlarm {
     NO = "NO",
     YES = "YES"
 }
+/**
+ * Valid values for Contact.AdditionalCareRequired
+ *
+ * Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
+ *
+ * @remarks Available options:
+ * - `NO` - No
+ * - `YES` - Yes
+ */
+export declare enum ContactAdditionalCareRequired {
+    NO = "NO",
+    YES = "YES"
+}
 /**
  * Valid values for Contact.MedicallyDependant
  *
@@ -253,6 +238,21 @@ export declare enum ContactMedicallyDependant {
     NO = "NO",
     YES = "YES"
 }
+/**
+ * Valid values for Contact.HomeownerStatus
+ *
+ * Homeowner Status (Sales - Contact)
+ *
+ * @remarks Available options:
+ * - `HOMEOWNER` - I own the property
+ * - `RENTER` - It is a rented property
+ * - `LIVING_WITH_PARENTS` - Living with parents
+ */
+export declare enum ContactHomeownerStatus {
+    I_OWN_THE_PROPERTY = "HOMEOWNER",
+    IT_IS_A_RENTED_PROPERTY = "RENTER",
+    LIVING_WITH_PARENTS = "LIVING_WITH_PARENTS"
+}
 /**
  * Valid values for Contact.WhitelistedTwilioQueue
  *
@@ -270,19 +270,6 @@ export declare enum ContactWhitelistedTwilioQueue {
     GENERAL_SUPPORT = "General Support",
     ORDER_MANAGEMENT_UPDATE = "Order Management - Update"
 }
-/**
- * Valid values for Contact.AdditionalCareRequired
- *
- * Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
- *
- * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
- */
-export declare enum ContactAdditionalCareRequired {
-    NO = "NO",
-    YES = "YES"
-}
 /**
  * Property keys for Contact
  * Use these constants instead of string literals for type safety
@@ -298,10 +285,10 @@ export declare enum ContactPropertyKeys {
     CompanyPosition = "CompanyPosition",
     /** hear about us other (Sales - Contact) */
     HearAboutUsOther = "HearAboutUsOther",
-    /** Customer consent for recording additional care requiremetns (Sales - Contact) */
-    AdditionalCareConsent = "AdditionalCareConsent",
     /** vulnerable customer */
     VulnerableCustomer = "VulnerableCustomer",
+    /** Customer consent for recording additional care requiremetns (Sales - Contact) */
+    AdditionalCareConsent = "AdditionalCareConsent",
     /** NONE if never registered, INACTIVE if requested a code, ACTIVE if completed registration (Sales - Contact) */
     PortalStatus = "PortalStatus",
     /** Referral Code (Sales - Contact) */
@@ -318,8 +305,6 @@ export declare enum ContactPropertyKeys {
     DirectDebitConsent = "DirectDebitConsent",
     /** Send if true otherwise they have opted-out if false (Sales - Contact) */
     MarketingSms = "MarketingSMS",
-    /** Homeowner Status (Sales - Contact) */
-    HomeownerStatus = "HomeownerStatus",
     /** Terms and Conditions Consent (Sales - Contact) */
     TermsAndConditionsConsent = "TermsAndConditionsConsent",
     /** previous/current provider (Sales - Contact) */
@@ -382,20 +367,22 @@ export declare enum ContactPropertyKeys {
     PortalLastActiveDate = "PortalLastActiveDate",
     /** When the customer last used or was last active on the native customer mobile app (Sales - Contact) */
     AppLastActiveDate = "AppLastActiveDate",
-    /** Any additional information */
-    AdditionalCareNotes = "AdditionalCareNotes",
     /** Does the customer use a Telecare Alarm (Sales - Contact) */
     TelecareAlarm = "TelecareAlarm",
     /** Select a care requirement */
     AdditionalCareReason = "AdditionalCareReason",
+    /** Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact) */
+    AdditionalCareRequired = "AdditionalCareRequired",
+    /** Any additional information */
+    AdditionalCareNotes = "AdditionalCareNotes",
     /** Is the customer medically dependant on their broadband (Sales - Contact) */
     MedicallyDependant = "MedicallyDependant",
+    /** Homeowner Status (Sales - Contact) */
+    HomeownerStatus = "HomeownerStatus",
     /** Used to whitelist this user to a specific twilio queue in a time range. */
     WhitelistedTwilioQueue = "WhitelistedTwilioQueue",
     /** Time when the whitelisting ends and the user falls back to the main IVR again. */
     WhitelistTwilioEndTime = "WhitelistTwilioEndTime",
-    /** Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact) */
-    AdditionalCareRequired = "AdditionalCareRequired",
     /** Phone number (Sales - Contact) */
     Phone = "Phone"
 }
@@ -436,18 +423,17 @@ export interface ContactProperties {
      * @hidden This field is hidden in the UI
      */
     HearAboutUsOther: string;
-    /** Customer consent for recording additional care requiremetns (Sales - Contact)
-     *
-     * @type {ENUM}
-     * @enum {ContactAdditionalCareConsent}
-     */
-    AdditionalCareConsent: ContactAdditionalCareConsent;
     /** vulnerable customer
      *
      * @type {BOOLEAN}
      * @hidden This field is hidden in the UI
      */
     VulnerableCustomer: boolean;
+    /** Customer consent for recording additional care requiremetns (Sales - Contact)
+     *
+     * @type {BOOLEAN}
+     */
+    AdditionalCareConsent: boolean;
     /** NONE if never registered, INACTIVE if requested a code, ACTIVE if completed registration (Sales - Contact)
      *
      * @type {ENUM}
@@ -499,12 +485,6 @@ export interface ContactProperties {
      * @readonly This field is read-only
      */
     MarketingSms: boolean;
-    /** Homeowner Status (Sales - Contact)
-     *
-     * @type {ENUM}
-     * @enum {ContactHomeownerStatus}
-     */
-    HomeownerStatus: ContactHomeownerStatus;
     /** Terms and Conditions Consent (Sales - Contact)
      *
      * @type {BOOLEAN}
@@ -702,11 +682,6 @@ export interface ContactProperties {
      * @hidden This field is hidden in the UI
      */
     AppLastActiveDate: string;
-    /** Any additional information
-     *
-     * @type {TEXT_LONG}
-     */
-    AdditionalCareNotes: string;
     /** Does the customer use a Telecare Alarm (Sales - Contact)
      *
      * @type {ENUM}
@@ -719,6 +694,17 @@ export interface ContactProperties {
      * @type {ENUM_MULTI_SELECT}
      */
     AdditionalCareReason: string;
+    /** Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
+     *
+     * @type {ENUM}
+     * @enum {ContactAdditionalCareRequired}
+     */
+    AdditionalCareRequired: ContactAdditionalCareRequired;
+    /** Any additional information
+     *
+     * @type {TEXT_LONG}
+     */
+    AdditionalCareNotes: string;
     /** Is the customer medically dependant on their broadband (Sales - Contact)
      *
      * @type {ENUM}
@@ -727,6 +713,12 @@ export interface ContactProperties {
      * @hidden This field is hidden in the UI
      */
     MedicallyDependant: ContactMedicallyDependant;
+    /** Homeowner Status (Sales - Contact)
+     *
+     * @type {ENUM}
+     * @enum {ContactHomeownerStatus}
+     */
+    HomeownerStatus: ContactHomeownerStatus;
     /** Used to whitelist this user to a specific twilio queue in a time range.
      *
      * @type {ENUM}
@@ -740,12 +732,6 @@ export interface ContactProperties {
      * @hidden This field is hidden in the UI
      */
     WhitelistTwilioEndTime: string;
-    /** Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
-     *
-     * @type {ENUM}
-     * @enum {ContactAdditionalCareRequired}
-     */
-    AdditionalCareRequired: ContactAdditionalCareRequired;
     /** Phone number (Sales - Contact)
      *
      * @type {PHONE_NUMBER_E164_GB}