@d19n/youfibre-odin-sdk 1.0.230 → 1.0.232

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

@@ -0,0 +1,81 @@
+/**
+ * ChangeBillingMode Action DTO
+ *
+ * Change the account billing mode between ORDER and ACCOUNT
+ *
+ * @module CrmModule
+ * @entity Account
+ * @actionKey ChangeBillingMode
+ * @event AccountBillingModelChanged
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * Properties for ChangeBillingMode action
+ *
+ * @property Required fields: 0
+ * @property Optional fields: 2
+ */
+export interface ChangeBillingModeProperties {
+    /**
+     * BillingMode
+     *
+     * Controls how invoices are generated for this account. ORDER (default): each order generates its own invoice on its own billing cycle. ACCOUNT: all orders are consolidated into a single invoice on the account billing day.
+     * @type {ENUM}
+     */
+    BillingMode?: string;
+    /**
+     * BillingDay
+     *
+     * Day of month when consolidated invoices are generated. Required when BillingMode is ACCOUNT. Must be 1-28 to avoid end-of-month date issues.
+     * @type {NUMBER}
+     */
+    BillingDay?: number;
+}
+/**
+ * ChangeBillingMode
+ *
+ * Change the account billing mode between ORDER and ACCOUNT
+ *
+ * @actionType UPDATE - Updates an existing Account record
+ * @module CrmModule
+ * @entity Account
+ * @event AccountBillingModelChanged
+ * @permission schema.action.changebillingmode.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class ChangeBillingModeDto extends OdinRecordUpdateDto<ChangeBillingModeProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "ChangeBillingMode";
+    static readonly MODULE_NAME = "CrmModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "AccountBillingModelChanged";
+    static readonly PERMISSION = "schema.action.changebillingmode.trigger";
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(record: OdinRecord<any> | {
+        id: string;
+        entity: string;
+        type?: string;
+    }, properties: ChangeBillingModeProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    });
+}
+/**
+ * RabbitMQ message payload for ChangeBillingMode updated events
+ *
+ * @event AccountBillingModelChanged
+ */
+export interface ChangeBillingModeMessage extends OdinRecordUpdatedEvent<ChangeBillingModeDto, ChangeBillingModeProperties> {
+}
+/**
+ * RabbitMQ routing key for ChangeBillingMode events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event AccountBillingModelChanged
+ */
+export declare const ROUTING_KEY_ACCOUNT_BILLING_MODEL_CHANGED = "AccountBillingModelChanged";

package/dist/actions-v2/ChangeBillingModeDto.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * ChangeBillingMode Action DTO
+ *
+ * Change the account billing mode between ORDER and ACCOUNT
+ *
+ * @module CrmModule
+ * @entity Account
+ * @actionKey ChangeBillingMode
+ * @event AccountBillingModelChanged
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_ACCOUNT_BILLING_MODEL_CHANGED = exports.ChangeBillingModeDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * ChangeBillingMode
+ *
+ * Change the account billing mode between ORDER and ACCOUNT
+ *
+ * @actionType UPDATE - Updates an existing Account record
+ * @module CrmModule
+ * @entity Account
+ * @event AccountBillingModelChanged
+ * @permission schema.action.changebillingmode.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class ChangeBillingModeDto extends core_1.OdinRecordUpdateDto {
+    constructor(record, properties, options) {
+        super({
+            id: record.id,
+            entity: record.entity,
+            type: record.type,
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+            stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
+        });
+        this.actionName = 'ChangeBillingMode';
+        this.schemaActionId = '805e0261-bc3b-41e3-8a69-79d4152613ab';
+        this.entity = 'CrmModule:Account';
+    }
+}
+exports.ChangeBillingModeDto = ChangeBillingModeDto;
+/** Used by SDK generators to identify action type */
+ChangeBillingModeDto.ACTION_TYPE = 'UPDATE';
+ChangeBillingModeDto.ACTION_KEY = 'ChangeBillingMode';
+ChangeBillingModeDto.MODULE_NAME = 'CrmModule';
+ChangeBillingModeDto.ENTITIES = ['Account'];
+ChangeBillingModeDto.EVENT_NAME = 'AccountBillingModelChanged';
+ChangeBillingModeDto.PERMISSION = 'schema.action.changebillingmode.trigger';
+/**
+ * RabbitMQ routing key for ChangeBillingMode events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event AccountBillingModelChanged
+ */
+exports.ROUTING_KEY_ACCOUNT_BILLING_MODEL_CHANGED = 'AccountBillingModelChanged';

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: 0
- * @property Optional fields: 8
+ * @property Required fields: 10
+ * @property Optional fields: 3
  */
 export interface CreateRecontractOrderProperties {
     /**
@@ -23,46 +23,85 @@ export interface CreateRecontractOrderProperties {
      *
      * the subscriber id is used as the identifier when provisioning on the network
      * @type {TEXT}
+     * @required
      */
-    SubscriberId?: string;
+    SubscriberId: string;
     /**
      * Active Date
      *
      * active date
      * @type {DATE}
+     * @required
      * @format DD/MM/YYYY
      */
-    ActiveDate?: string;
+    ActiveDate: string;
     /**
      * Billing Start Date
      *
      * Billing start date
      * @type {DATE}
+     * @required
      * @format DD/MM/YYYY
      */
-    BillingStartDate?: string;
+    BillingStartDate: string;
     /**
      * Contract Start Date
      *
      * the date the contract start
      * @type {DATE}
+     * @required
      * @format DD/MM/YYYY
      */
-    ContractStartDate?: string;
+    ContractStartDate: string;
     /**
      * Billing Day
      *
      * Billing day in the month
      * @type {NUMBER}
+     * @required
      */
-    BillingDay?: number;
+    BillingDay: number;
     /**
      * Previous Order ID
      *
      * the previous order prior to an amendment or recontract
      * @type {LOOKUP}
+     * @required
      */
-    PreviousOrderId?: string;
+    PreviousOrderId: string;
+    /**
+     * Amendment Date
+     *
+     * the datetime when the amendment was performed
+     * @type {DATE}
+     * @required
+     * @format DD/MM/YYYY
+     */
+    AmendmentDate: string;
+    /**
+     * BillingTerms
+     *
+     * Billing terms i.e NET 15,30
+     * @type {ENUM}
+     * @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
      *
@@ -71,13 +110,19 @@ export interface CreateRecontractOrderProperties {
      */
     Source?: string;
     /**
-     * Amendment Date
+     * ReferralEmail
      *
-     * the datetime when the amendment was performed
-     * @type {DATE}
-     * @format DD/MM/YYYY
+     * referral email
+     * @type {TEXT}
+     */
+    ReferralEmail?: string;
+    /**
+     * Provider
+     *
+     * network provider
+     * @type {ENUM}
      */
-    AmendmentDate?: string;
+    Provider?: string;
 }
 /**
  * CreateRecontractOrder

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

@@ -29,14 +29,14 @@ import { FileProperties } from './File';
 export declare enum AccountEntityTypes {
     /** Business accounts */
     BUSINESS = "BUSINESS",
-    /** This is the default record type */
-    DEFAULT = "DEFAULT",
     /** Multiple accounts are for customers who want to purchase multiple services at many addresses */
     MULTIPLE = "MULTIPLE",
     /** Primary account */
     PRIMARY = "PRIMARY",
     /** Reseller */
-    RESELLER = "RESELLER"
+    RESELLER = "RESELLER",
+    /** This is the account where service is being delivered */
+    SERVICE = "SERVICE"
 }
 /**
  * Valid values for Account.Status
@@ -142,6 +142,8 @@ export declare enum AccountPropertyKeys {
     BillingDay = "BillingDay",
     /** VerificationCode */
     VerificationCode = "VerificationCode",
+    /** For SERVICE under RESELLER/TENANT */
+    ParentAccountRef = "ParentAccountRef",
     /** the billing address */
     AddressId = "AddressId"
 }
@@ -208,6 +210,11 @@ export interface AccountProperties {
      * @type {TEXT}
      */
     VerificationCode?: string;
+    /** For SERVICE under RESELLER/TENANT
+     *
+     * @type {UUID}
+     */
+    ParentAccountRef?: string;
     /** the billing address
      *
      * @type {LOOKUP}

package/dist/entities-v2/Account.js

@@ -21,14 +21,14 @@ var AccountEntityTypes;
 (function (AccountEntityTypes) {
     /** Business accounts */
     AccountEntityTypes["BUSINESS"] = "BUSINESS";
-    /** This is the default record type */
-    AccountEntityTypes["DEFAULT"] = "DEFAULT";
     /** Multiple accounts are for customers who want to purchase multiple services at many addresses */
     AccountEntityTypes["MULTIPLE"] = "MULTIPLE";
     /** Primary account */
     AccountEntityTypes["PRIMARY"] = "PRIMARY";
     /** Reseller */
     AccountEntityTypes["RESELLER"] = "RESELLER";
+    /** This is the account where service is being delivered */
+    AccountEntityTypes["SERVICE"] = "SERVICE";
 })(AccountEntityTypes = exports.AccountEntityTypes || (exports.AccountEntityTypes = {}));
 /**
  * Valid values for Account.Status
@@ -140,6 +140,8 @@ var AccountPropertyKeys;
     AccountPropertyKeys["BillingDay"] = "BillingDay";
     /** VerificationCode */
     AccountPropertyKeys["VerificationCode"] = "VerificationCode";
+    /** For SERVICE under RESELLER/TENANT */
+    AccountPropertyKeys["ParentAccountRef"] = "ParentAccountRef";
     /** the billing address */
     AccountPropertyKeys["AddressId"] = "AddressId";
 })(AccountPropertyKeys = exports.AccountPropertyKeys || (exports.AccountPropertyKeys = {}));

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

@@ -128,6 +128,8 @@ export declare enum BusinessAccountPropertyKeys {
     BillingDay = "BillingDay",
     /** VerificationCode */
     VerificationCode = "VerificationCode",
+    /** For SERVICE under RESELLER/TENANT */
+    ParentAccountRef = "ParentAccountRef",
     /** the billing address */
     AddressId = "AddressId"
 }
@@ -189,6 +191,11 @@ export interface BusinessAccountProperties {
      * @type {TEXT}
      */
     VerificationCode?: string;
+    /** For SERVICE under RESELLER/TENANT
+     *
+     * @type {UUID}
+     */
+    ParentAccountRef?: string;
     /** the billing address
      *
      * @type {LOOKUP}

package/dist/entities-v2/BusinessAccount.js

@@ -124,6 +124,8 @@ var BusinessAccountPropertyKeys;
     BusinessAccountPropertyKeys["BillingDay"] = "BillingDay";
     /** VerificationCode */
     BusinessAccountPropertyKeys["VerificationCode"] = "VerificationCode";
+    /** For SERVICE under RESELLER/TENANT */
+    BusinessAccountPropertyKeys["ParentAccountRef"] = "ParentAccountRef";
     /** the billing address */
     BusinessAccountPropertyKeys["AddressId"] = "AddressId";
 })(BusinessAccountPropertyKeys = exports.BusinessAccountPropertyKeys || (exports.BusinessAccountPropertyKeys = {}));

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 {
-    /** description of the credit note */
-    Description = "Description",
     /** amount of the credit note */
     Amount = "Amount",
-    /** credit note status */
-    Status = "Status",
+    /** description of the credit note */
+    Description = "Description",
     /** the record # of the invoice */
     InvoiceRef = "InvoiceRef",
+    /** credit note reason */
+    Reason = "Reason",
     /** reason code */
     ReasonCode = "ReasonCode",
-    /** credit note reason */
-    Reason = "Reason"
+    /** credit note status */
+    Status = "Status"
 }
 /**
  * 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;
-    /** credit note status
+    /** description of the credit note
      *
-     * @type {TEXT}
-     * @hidden This field is hidden in the UI
+     * @type {TEXT_LONG}
      */
-    Status?: string;
+    Description?: 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 reason
+    /** credit note status
      *
-     * @type {ENUM}
-     * @enum {CreditNoteReason}
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
      */
-    Reason?: CreditNoteReason;
+    Status?: string;
 }
 /**
  * CreditNote entity from BillingModule

package/dist/entities-v2/CreditNote.js

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

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

@@ -247,8 +247,6 @@ export declare enum InvoicePropertyKeys {
     DiscountValue = "DiscountValue",
     /** the type of discount */
     DiscountType = "DiscountType",
-    /** order reference */
-    OrderRef = "OrderRef",
     /** invoice name */
     Name = "Name",
     /** timestamp indicating when the DunningStatus changed */
@@ -293,8 +291,12 @@ export declare enum InvoicePropertyKeys {
     BillingMode = "BillingMode",
     /** JSON array of order IDs included in this invoice. Only populated for account-based invoices (BillingMode=ACCOUNT). Example: ["uuid-1","uuid-2"]. Used to track which orders contributed to a consolidated invoice. */
     OrderRefs = "OrderRefs",
+    /** order reference */
+    OrderRef = "OrderRef",
     /** Used to identify what billing period this invoice includes */
     BillingPeriodType = "BillingPeriodType",
+    /** JSON array of sub-account IDs */
+    SubAccountRefs = "SubAccountRefs",
     /** status of the invoice */
     Status = "Status",
     /** will attempt payment retries if failed */
@@ -425,12 +427,6 @@ export interface InvoiceProperties {
      * @hidden This field is hidden in the UI
      */
     DiscountType?: InvoiceDiscountType;
-    /** order reference
-     *
-     * @type {UUID}
-     * @hidden This field is hidden in the UI
-     */
-    OrderRef?: string;
     /** invoice name
      *
      * @type {TEXT}
@@ -577,6 +573,12 @@ export interface InvoiceProperties {
      * @type {JSON}
      */
     OrderRefs?: string;
+    /** order reference
+     *
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
+     */
+    OrderRef?: string;
     /** Used to identify what billing period this invoice includes
      *
      * @type {ENUM}
@@ -584,6 +586,11 @@ export interface InvoiceProperties {
      * @enum {InvoiceBillingPeriodType}
      */
     BillingPeriodType?: InvoiceBillingPeriodType;
+    /** JSON array of sub-account IDs
+     *
+     * @type {JSON}
+     */
+    SubAccountRefs?: string;
     /** status of the invoice
      *
      * @type {ENUM}

package/dist/entities-v2/Invoice.js

@@ -244,8 +244,6 @@ var InvoicePropertyKeys;
     InvoicePropertyKeys["DiscountValue"] = "DiscountValue";
     /** the type of discount */
     InvoicePropertyKeys["DiscountType"] = "DiscountType";
-    /** order reference */
-    InvoicePropertyKeys["OrderRef"] = "OrderRef";
     /** invoice name */
     InvoicePropertyKeys["Name"] = "Name";
     /** timestamp indicating when the DunningStatus changed */
@@ -290,8 +288,12 @@ var InvoicePropertyKeys;
     InvoicePropertyKeys["BillingMode"] = "BillingMode";
     /** JSON array of order IDs included in this invoice. Only populated for account-based invoices (BillingMode=ACCOUNT). Example: ["uuid-1","uuid-2"]. Used to track which orders contributed to a consolidated invoice. */
     InvoicePropertyKeys["OrderRefs"] = "OrderRefs";
+    /** order reference */
+    InvoicePropertyKeys["OrderRef"] = "OrderRef";
     /** Used to identify what billing period this invoice includes */
     InvoicePropertyKeys["BillingPeriodType"] = "BillingPeriodType";
+    /** JSON array of sub-account IDs */
+    InvoicePropertyKeys["SubAccountRefs"] = "SubAccountRefs";
     /** status of the invoice */
     InvoicePropertyKeys["Status"] = "Status";
     /** will attempt payment retries if failed */

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

@@ -145,6 +145,10 @@ export declare enum InvoiceItemPropertyKeys {
     OrderTitle = "OrderTitle",
     /** Source order ID that this line item originated from. Used in account-based invoices to group and filter items by their source order. Enables per-order subtotals on consolidated invoices. */
     OrderRef = "OrderRef",
+    /** Source sub-account of a (RESELLER/TENANT) account */
+    SubAccountRef = "SubAccountRef",
+    /** The title of the sub-account */
+    SubAccountTitle = "SubAccountTitle",
     /** Billing period start date */
     BillingPeriodStart = "BillingPeriodStart",
     /** Billing period end date */
@@ -321,6 +325,16 @@ export interface InvoiceItemProperties {
      * @type {UUID}
      */
     OrderRef?: string;
+    /** Source sub-account of a (RESELLER/TENANT) account
+     *
+     * @type {UUID}
+     */
+    SubAccountRef?: string;
+    /** The title of the sub-account
+     *
+     * @type {TEXT}
+     */
+    SubAccountTitle?: string;
     /** Billing period start date
      *
      * @type {DATE}

package/dist/entities-v2/InvoiceItem.js

@@ -154,6 +154,10 @@ var InvoiceItemPropertyKeys;
     InvoiceItemPropertyKeys["OrderTitle"] = "OrderTitle";
     /** Source order ID that this line item originated from. Used in account-based invoices to group and filter items by their source order. Enables per-order subtotals on consolidated invoices. */
     InvoiceItemPropertyKeys["OrderRef"] = "OrderRef";
+    /** Source sub-account of a (RESELLER/TENANT) account */
+    InvoiceItemPropertyKeys["SubAccountRef"] = "SubAccountRef";
+    /** The title of the sub-account */
+    InvoiceItemPropertyKeys["SubAccountTitle"] = "SubAccountTitle";
     /** Billing period start date */
     InvoiceItemPropertyKeys["BillingPeriodStart"] = "BillingPeriodStart";
     /** Billing period end date */

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

@@ -128,6 +128,8 @@ export declare enum MultipleAccountPropertyKeys {
     BillingDay = "BillingDay",
     /** VerificationCode */
     VerificationCode = "VerificationCode",
+    /** For SERVICE under RESELLER/TENANT */
+    ParentAccountRef = "ParentAccountRef",
     /** the billing address */
     AddressId = "AddressId"
 }
@@ -189,6 +191,11 @@ export interface MultipleAccountProperties {
      * @type {TEXT}
      */
     VerificationCode?: string;
+    /** For SERVICE under RESELLER/TENANT
+     *
+     * @type {UUID}
+     */
+    ParentAccountRef?: string;
     /** the billing address
      *
      * @type {LOOKUP}

package/dist/entities-v2/MultipleAccount.js

@@ -124,6 +124,8 @@ var MultipleAccountPropertyKeys;
     MultipleAccountPropertyKeys["BillingDay"] = "BillingDay";
     /** VerificationCode */
     MultipleAccountPropertyKeys["VerificationCode"] = "VerificationCode";
+    /** For SERVICE under RESELLER/TENANT */
+    MultipleAccountPropertyKeys["ParentAccountRef"] = "ParentAccountRef";
     /** the billing address */
     MultipleAccountPropertyKeys["AddressId"] = "AddressId";
 })(MultipleAccountPropertyKeys = exports.MultipleAccountPropertyKeys || (exports.MultipleAccountPropertyKeys = {}));