@d19n/youfibre-odin-sdk 1.0.227 → 1.0.228

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

@@ -1,15 +1,68 @@
+/**
+ * ActivateOrder Action DTO
+ *
+ * Used to manually activate an Order. Admin feature
+ *
+ * @module OrderModule
+ * @entity Order
+ * @actionKey ActivateOrder
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
 import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * Properties for ActivateOrder action
+ *
+ * @property Required fields: 2
+ * @property Optional fields: 1
+ */
 export interface ActivateOrderProperties {
+    /**
+     * ActiveDate
+     *
+     * active date
+     * @type {DATE}
+     * @required
+     * @default Dynamic: {date_today}
+     * @format DD/MM/YYYY
+     */
     ActiveDate: string;
+    /**
+     * BillingStartDate
+     *
+     * Billing start date
+     * @type {DATE}
+     * @required
+     * @default Dynamic: {date_today}
+     * @format DD/MM/YYYY
+     */
     BillingStartDate: string;
+    /**
+     * DesiredBillingDay
+     *
+     * Desired Billing Day
+     * @type {NUMBER}
+     */
     DesiredBillingDay?: number;
 }
+/**
+ * ActivateOrder
+ *
+ * Used to manually activate an Order. Admin feature
+ *
+ * @actionType UPDATE - Updates an existing Order record
+ * @module OrderModule
+ * @entity Order
+ * @permission schema.action.activateorder.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
 export declare class ActivateOrderDto extends OdinRecordUpdateDto<ActivateOrderProperties> {
-    /** Used by record-wrapper-generator to determine action type */
+    /** Used by SDK generators to identify action type */
     static readonly ACTION_TYPE = "UPDATE";
     static readonly ACTION_KEY = "ActivateOrder";
     static readonly MODULE_NAME = "OrderModule";
     static readonly ENTITIES: string[];
+    static readonly PERMISSION = "schema.action.activateorder.trigger";
     readonly actionName: string;
     readonly schemaActionId: string;
     readonly entity: string;
@@ -22,6 +75,17 @@ export declare class ActivateOrderDto extends OdinRecordUpdateDto<ActivateOrderP
         stageKey?: string;
     });
 }
+/**
+ * RabbitMQ message payload for ActivateOrder updated events
+ *
+ * @event ActivateOrder
+ */
 export interface ActivateOrderMessage extends OdinRecordUpdatedEvent<ActivateOrderDto, ActivateOrderProperties> {
 }
+/**
+ * RabbitMQ routing key for ActivateOrder events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event ActivateOrder
+ */
 export declare const ROUTING_KEY_ACTIVATE_ORDER = "ActivateOrder";

package/dist/actions-v2/ActivateOrderDto.js

@@ -1,7 +1,29 @@
 "use strict";
+/**
+ * ActivateOrder Action DTO
+ *
+ * Used to manually activate an Order. Admin feature
+ *
+ * @module OrderModule
+ * @entity Order
+ * @actionKey ActivateOrder
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ROUTING_KEY_ACTIVATE_ORDER = exports.ActivateOrderDto = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * ActivateOrder
+ *
+ * Used to manually activate an Order. Admin feature
+ *
+ * @actionType UPDATE - Updates an existing Order record
+ * @module OrderModule
+ * @entity Order
+ * @permission schema.action.activateorder.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
 class ActivateOrderDto extends core_1.OdinRecordUpdateDto {
     constructor(record, properties, options) {
         super({
@@ -18,9 +40,16 @@ class ActivateOrderDto extends core_1.OdinRecordUpdateDto {
     }
 }
 exports.ActivateOrderDto = ActivateOrderDto;
-/** Used by record-wrapper-generator to determine action type */
+/** Used by SDK generators to identify action type */
 ActivateOrderDto.ACTION_TYPE = 'UPDATE';
 ActivateOrderDto.ACTION_KEY = 'ActivateOrder';
 ActivateOrderDto.MODULE_NAME = 'OrderModule';
 ActivateOrderDto.ENTITIES = ['Order'];
+ActivateOrderDto.PERMISSION = 'schema.action.activateorder.trigger';
+/**
+ * RabbitMQ routing key for ActivateOrder events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event ActivateOrder
+ */
 exports.ROUTING_KEY_ACTIVATE_ORDER = 'ActivateOrder';

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

@@ -1,14 +1,54 @@
+/**
+ * ActivateRecontractOrder Action DTO
+ *
+ * Activates the new recontracted order by moving it to Active stage
+ *
+ * @module OrderModule
+ * @entity Order
+ * @actionKey ActivateRecontractOrder
+ * @event ActivateRecontractOrder
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
 import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for ActivateRecontractOrder step flow events
+ *
+ * @event ActivateRecontractOrder
+ */
 export interface ActivateRecontractOrderMessage extends OdinRecordUpdatedEvent<ActivateRecontractOrderDto, {}> {
 }
+/**
+ * Properties for ActivateRecontractOrder action
+ *
+ */
 export interface ActivateRecontractOrderProperties {
 }
+/**
+ * ActivateRecontractOrder
+ *
+ * Activates the new recontracted order by moving it to Active stage
+ *
+ * @actionType STEP_FLOW - Multi-step workflow action
+ * @module OrderModule
+ * @entity Order
+ * @targetStages OrderStageActive
+ * @event ActivateRecontractOrder
+ * @permission schema.action.activaterecontractorder.trigger
+ * @category LIFECYCLE
+ * @riskLevel MEDIUM
+ * @benchmark This action is tracked for performance benchmarks
+ * @benchmarkTags order, recontracting, contract-renewal, activation, stage-transition
+ */
 export declare class ActivateRecontractOrderDto extends OdinRecordUpdateDto<Record<string, any>> {
-    /** Used by record-wrapper-generator to determine action type */
+    /** Used by SDK generators to identify action type */
     static readonly ACTION_TYPE = "UPDATE";
     static readonly ACTION_KEY = "ActivateRecontractOrder";
     static readonly MODULE_NAME = "OrderModule";
     static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "ActivateRecontractOrder";
+    static readonly PERMISSION = "schema.action.activaterecontractorder.trigger";
+    static readonly TARGET_STAGES: readonly ["OrderStageActive"];
     readonly actionName: string;
     readonly schemaActionId: string;
     readonly entity: string;
@@ -20,7 +60,14 @@ export declare class ActivateRecontractOrderDto extends OdinRecordUpdateDto<Reco
     }, options?: {
         journeyId?: string;
     });
+    /** Step classes that can be used with this action */
     static readonly stepClasses: readonly [];
     steps: [];
 }
+/**
+ * RabbitMQ routing key for ActivateRecontractOrder events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event ActivateRecontractOrder
+ */
 export declare const ROUTING_KEY_ACTIVATE_RECONTRACT_ORDER = "ActivateRecontractOrder";

package/dist/actions-v2/ActivateRecontractOrderDto.js

@@ -1,7 +1,35 @@
 "use strict";
+/**
+ * ActivateRecontractOrder Action DTO
+ *
+ * Activates the new recontracted order by moving it to Active stage
+ *
+ * @module OrderModule
+ * @entity Order
+ * @actionKey ActivateRecontractOrder
+ * @event ActivateRecontractOrder
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ROUTING_KEY_ACTIVATE_RECONTRACT_ORDER = exports.ActivateRecontractOrderDto = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * ActivateRecontractOrder
+ *
+ * Activates the new recontracted order by moving it to Active stage
+ *
+ * @actionType STEP_FLOW - Multi-step workflow action
+ * @module OrderModule
+ * @entity Order
+ * @targetStages OrderStageActive
+ * @event ActivateRecontractOrder
+ * @permission schema.action.activaterecontractorder.trigger
+ * @category LIFECYCLE
+ * @riskLevel MEDIUM
+ * @benchmark This action is tracked for performance benchmarks
+ * @benchmarkTags order, recontracting, contract-renewal, activation, stage-transition
+ */
 class ActivateRecontractOrderDto extends core_1.OdinRecordUpdateDto {
     constructor(record, options) {
         super({
@@ -18,10 +46,20 @@ class ActivateRecontractOrderDto extends core_1.OdinRecordUpdateDto {
     }
 }
 exports.ActivateRecontractOrderDto = ActivateRecontractOrderDto;
-/** Used by record-wrapper-generator to determine action type */
+/** Used by SDK generators to identify action type */
 ActivateRecontractOrderDto.ACTION_TYPE = 'UPDATE';
 ActivateRecontractOrderDto.ACTION_KEY = 'ActivateRecontractOrder';
 ActivateRecontractOrderDto.MODULE_NAME = 'OrderModule';
 ActivateRecontractOrderDto.ENTITIES = ['Order'];
+ActivateRecontractOrderDto.EVENT_NAME = 'ActivateRecontractOrder';
+ActivateRecontractOrderDto.PERMISSION = 'schema.action.activaterecontractorder.trigger';
+ActivateRecontractOrderDto.TARGET_STAGES = ['OrderStageActive'];
+/** Step classes that can be used with this action */
 ActivateRecontractOrderDto.stepClasses = [];
+/**
+ * RabbitMQ routing key for ActivateRecontractOrder events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event ActivateRecontractOrder
+ */
 exports.ROUTING_KEY_ACTIVATE_RECONTRACT_ORDER = 'ActivateRecontractOrder';

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

@@ -1,25 +1,155 @@
+/**
+ * AddressCreate Action DTO
+ *
+ * Address create action
+ *
+ * @module CrmModule
+ * @entity Address
+ * @actionKey AddressCreate
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
 import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * Properties for AddressCreate action
+ *
+ * @property Required fields: 1
+ * @property Optional fields: 16
+ */
 export interface AddressCreateProperties {
+    /**
+     * SPRN
+     *
+     * sprn reference for Netomnia addresses
+     * @type {NUMBER}
+     * @required
+     */
     Sprn: number;
+    /**
+     * ExPolygonId
+     *
+     * the id of the exchange polygon
+     * @type {NUMBER}
+     */
     ExPolygonId?: number;
+    /**
+     * Sales Status
+     *
+     * The sales status for the address
+     * @type {ENUM}
+     */
     SalesStatus?: string;
+    /**
+     * Address Line1
+     *
+     * The first line of the contacts address.
+     * @type {TEXT}
+     */
     AddressLine1?: string;
+    /**
+     * Building Number
+     *
+     * the building number for the address
+     * @type {NUMBER}
+     */
     BuildingNumber?: number;
+    /**
+     * Build Status
+     *
+     * current build status for the area
+     * @type {TEXT}
+     */
     BuildStatus?: string;
+    /**
+     * City
+     *
+     * The city of the contacts address.
+     * @type {TEXT}
+     */
     City?: string;
+    /**
+     * Full Address
+     *
+     * full address
+     * @type {TEXT}
+     */
     FullAddress?: string;
+    /**
+     * L1 Polygon Id
+     *
+     * Id of the  l1 polygon
+     * @type {NUMBER}
+     */
     L1PolygonId?: number;
+    /**
+     * L2 Polygon Id
+     *
+     * the id of the l2 polygon
+     * @type {NUMBER}
+     */
     L2PolygonId?: number;
+    /**
+     * L4 Polygon Id
+     *
+     * the id of the l4 polygon
+     * @type {NUMBER}
+     */
     L4PolygonId?: number;
+    /**
+     * LM Polygon Id
+     *
+     * the id of the LM polygon (MDU properties)
+     * @type {NUMBER}
+     */
     LmPolygonId?: number;
+    /**
+     * Netomnia Sales Status
+     *
+     * the sales status set by netmonia
+     * @type {TEXT}
+     */
     NetomniaSalesStatus?: string;
+    /**
+     * Postal Code
+     *
+     * The postal code of the contacts address.
+     * @type {TEXT}
+     */
     PostalCode?: string;
+    /**
+     * UDPRN
+     *
+     * The Unique Delivery Point Reference Number
+     * @type {NUMBER}
+     */
     Udprn?: number;
+    /**
+     * UMPRN
+     *
+     * The Unique Multiple Premise Reference Number
+     * @type {TEXT}
+     */
     Umprn?: string;
+    /**
+     * UPRN
+     *
+     * the uprn to identify the premise
+     * @type {NUMBER}
+     */
     Uprn?: number;
 }
+/**
+ * AddressCreate
+ *
+ * Address create action
+ *
+ * @actionType CREATE - Creates a new Address record
+ * @module CrmModule
+ * @entity Address
+ * @benchmark This action is tracked for performance benchmarks
+ */
 export declare class AddressCreateDto extends OdinRecordCreateDto<AddressCreateProperties> {
-    /** Used by record-wrapper-generator to determine action type */
+    /** Used by SDK generators to identify action type */
     static readonly ACTION_TYPE = "CREATE";
     static readonly ACTION_KEY = "AddressCreate";
     static readonly MODULE_NAME = "CrmModule";
@@ -31,6 +161,17 @@ export declare class AddressCreateDto extends OdinRecordCreateDto<AddressCreateP
         journeyId?: string;
     });
 }
+/**
+ * RabbitMQ message payload for AddressCreate created events
+ *
+ * @event AddressCreate
+ */
 export interface AddressCreateMessage extends OdinRecordCreatedEvent<AddressCreateDto, AddressCreateProperties> {
 }
+/**
+ * RabbitMQ routing key for AddressCreate events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event AddressCreate
+ */
 export declare const ROUTING_KEY_ADDRESS_CREATE = "AddressCreate";

package/dist/actions-v2/AddressCreateDto.js

@@ -1,7 +1,28 @@
 "use strict";
+/**
+ * AddressCreate Action DTO
+ *
+ * Address create action
+ *
+ * @module CrmModule
+ * @entity Address
+ * @actionKey AddressCreate
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ROUTING_KEY_ADDRESS_CREATE = exports.AddressCreateDto = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * AddressCreate
+ *
+ * Address create action
+ *
+ * @actionType CREATE - Creates a new Address record
+ * @module CrmModule
+ * @entity Address
+ * @benchmark This action is tracked for performance benchmarks
+ */
 class AddressCreateDto extends core_1.OdinRecordCreateDto {
     constructor(properties, options) {
         super({
@@ -16,9 +37,15 @@ class AddressCreateDto extends core_1.OdinRecordCreateDto {
     }
 }
 exports.AddressCreateDto = AddressCreateDto;
-/** Used by record-wrapper-generator to determine action type */
+/** Used by SDK generators to identify action type */
 AddressCreateDto.ACTION_TYPE = 'CREATE';
 AddressCreateDto.ACTION_KEY = 'AddressCreate';
 AddressCreateDto.MODULE_NAME = 'CrmModule';
 AddressCreateDto.ENTITIES = ['Address'];
+/**
+ * RabbitMQ routing key for AddressCreate events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event AddressCreate
+ */
 exports.ROUTING_KEY_ADDRESS_CREATE = 'AddressCreate';

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

@@ -1,9 +1,42 @@
+/**
+ * AddressUpdate Action DTO
+ *
+ * Address update action
+ *
+ * @module CrmModule
+ * @entity Address
+ * @actionKey AddressUpdate
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
 import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * Properties for AddressUpdate action
+ *
+ * @property Required fields: 0
+ * @property Optional fields: 1
+ */
 export interface AddressUpdateProperties {
+    /**
+     * Classification
+     *
+     * the address classification from ab data
+     * @type {TEXT}
+     */
     Classification?: string;
 }
+/**
+ * AddressUpdate
+ *
+ * Address update action
+ *
+ * @actionType UPDATE - Updates an existing Address record
+ * @module CrmModule
+ * @entity Address
+ * @benchmark This action is tracked for performance benchmarks
+ */
 export declare class AddressUpdateDto extends OdinRecordUpdateDto<AddressUpdateProperties> {
-    /** Used by record-wrapper-generator to determine action type */
+    /** Used by SDK generators to identify action type */
     static readonly ACTION_TYPE = "UPDATE";
     static readonly ACTION_KEY = "AddressUpdate";
     static readonly MODULE_NAME = "CrmModule";
@@ -20,6 +53,17 @@ export declare class AddressUpdateDto extends OdinRecordUpdateDto<AddressUpdateP
         stageKey?: string;
     });
 }
+/**
+ * RabbitMQ message payload for AddressUpdate updated events
+ *
+ * @event AddressUpdate
+ */
 export interface AddressUpdateMessage extends OdinRecordUpdatedEvent<AddressUpdateDto, AddressUpdateProperties> {
 }
+/**
+ * RabbitMQ routing key for AddressUpdate events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event AddressUpdate
+ */
 export declare const ROUTING_KEY_ADDRESS_UPDATE = "AddressUpdate";

package/dist/actions-v2/AddressUpdateDto.js

@@ -1,7 +1,28 @@
 "use strict";
+/**
+ * AddressUpdate Action DTO
+ *
+ * Address update action
+ *
+ * @module CrmModule
+ * @entity Address
+ * @actionKey AddressUpdate
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ROUTING_KEY_ADDRESS_UPDATE = exports.AddressUpdateDto = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * AddressUpdate
+ *
+ * Address update action
+ *
+ * @actionType UPDATE - Updates an existing Address record
+ * @module CrmModule
+ * @entity Address
+ * @benchmark This action is tracked for performance benchmarks
+ */
 class AddressUpdateDto extends core_1.OdinRecordUpdateDto {
     constructor(record, properties, options) {
         super({
@@ -18,9 +39,15 @@ class AddressUpdateDto extends core_1.OdinRecordUpdateDto {
     }
 }
 exports.AddressUpdateDto = AddressUpdateDto;
-/** Used by record-wrapper-generator to determine action type */
+/** Used by SDK generators to identify action type */
 AddressUpdateDto.ACTION_TYPE = 'UPDATE';
 AddressUpdateDto.ACTION_KEY = 'AddressUpdate';
 AddressUpdateDto.MODULE_NAME = 'CrmModule';
 AddressUpdateDto.ENTITIES = ['Address'];
+/**
+ * RabbitMQ routing key for AddressUpdate events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event AddressUpdate
+ */
 exports.ROUTING_KEY_ADDRESS_UPDATE = 'AddressUpdate';

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

@@ -1,17 +1,83 @@
+/**
+ * ApproveCBO Action DTO
+ *
+ * Step to approve CBO
+ *
+ * @module OrderModule
+ * @entity ContractBuyOut
+ * @entityType DEFAULT
+ * @actionKey ApproveCBO
+ * @event ApproveCBO
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
 import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * Properties for ApproveCBO action
+ *
+ * @property Required fields: 3
+ * @property Optional fields: 1
+ */
 export interface ApproveCboProperties {
+    /**
+     * Previous Provider
+     *
+     * Select
+     * @type {ENUM}
+     * @required
+     * @default Dynamic: {source_record_properties_PreviousProvider}
+     */
     PreviousProvider: string;
+    /**
+     * Amount
+     *
+     * Enter amount
+     * @type {CURRENCY}
+     * @required
+     * @default Dynamic: {source_record_properties_Amount}
+     */
     Amount: string;
+    /**
+     * Have you verified the final bill?
+     *
+     * Final Bill Verifired
+     * @type {BOOLEAN}
+     * @required
+     * @default Dynamic: {source_record_properties_FinalBillVerified}
+     * @validWhen FinalBillVerified eq [true]
+     */
     FinalBillVerified: boolean;
+    /**
+     * Final Bill
+     *
+     * Please add
+     * @type {FILE_MULTIPLE}
+     * @default Dynamic: {source_record_properties_FinalBill}
+     */
     FinalBill?: undefined;
 }
+/**
+ * ApproveCBO
+ *
+ * Step to approve CBO
+ *
+ * @actionType UPDATE - Updates an existing ContractBuyOut record
+ * @module OrderModule
+ * @entity ContractBuyOut
+ * @entityType DEFAULT (Default)
+ * @event ApproveCBO
+ * @permission schema.action.approvecbo.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
 export declare class ApproveCboDto extends OdinRecordUpdateDto<ApproveCboProperties> {
-    /** Used by record-wrapper-generator to determine action type */
+    /** Used by SDK generators to identify action type */
     static readonly ACTION_TYPE = "UPDATE";
     static readonly ACTION_KEY = "ApproveCBO";
     static readonly MODULE_NAME = "OrderModule";
     static readonly ENTITIES: string[];
     static readonly ENTITY_TYPE = "DEFAULT";
+    static readonly EVENT_NAME = "ApproveCBO";
+    static readonly PERMISSION = "schema.action.approvecbo.trigger";
     readonly actionName: string;
     readonly schemaActionId: string;
     readonly entity: string;
@@ -24,6 +90,17 @@ export declare class ApproveCboDto extends OdinRecordUpdateDto<ApproveCboPropert
         stageKey?: string;
     });
 }
+/**
+ * RabbitMQ message payload for ApproveCBO updated events
+ *
+ * @event ApproveCBO
+ */
 export interface ApproveCboMessage extends OdinRecordUpdatedEvent<ApproveCboDto, ApproveCboProperties> {
 }
+/**
+ * RabbitMQ routing key for ApproveCBO events
+ *
+ * Subscribe to this key to receive notifications when this action completes.
+ * @event ApproveCBO
+ */
 export declare const ROUTING_KEY_APPROVE_CBO = "ApproveCBO";