@d19n/youfibre-odin-sdk 2.0.49 → 2.0.51-beta.0

package/README.md

@@ -352,7 +352,7 @@ This SDK includes **164** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **595** actions.
+This SDK includes **596** actions.
 
 ### Action Types
 
@@ -386,6 +386,7 @@ This SDK includes **595** actions.
 | `MoveOrderFromDraftToAnyStage` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromDraftToAnyStage |
 | `MoveOrderFromPendingCancellationToActive` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromPendingCancellationToActive |
 | `MoveOrderFromPreOrderToCancelled` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromPreOrderToCancelled |
+| `MoveOrderFromSupplyToCancelled` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToCancelled |
 | `MoveOrderToActive` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Update.ActivateOrder |
 | `MoveOrderToDeactivatedFromActive` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderToDeactivatedFromActive |
 | `OderUpdate` | UPDATE | k1.t-hEOJjsDb.OrderModule.Order.Update.OderUpdate |
@@ -417,6 +418,8 @@ This SDK includes **595** actions.
 
 **MoveOrderFromPreOrderToCancelled Target Stages:** `OrderStageCancelled`
 
+**MoveOrderFromSupplyToCancelled Target Stages:** `OrderStageCancelled`
+
 **MoveOrderToActive Target Stages:** `OrderStageActive`
 
 **MoveOrderToDeactivatedFromActive Target Stages:** `OrderStageDeactivated`

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

@@ -0,0 +1,112 @@
+/**
+ * MoveOrderFromSupplyToCancelled Action DTO
+ *
+ * MoveOrderFromSupplyToCancelled
+ *
+ * @module OrderModule
+ * @entity Order
+ * @actionKey MoveOrderFromSupplyToCancelled
+ * @event k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToCancelled
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+declare type StepClassMap = {};
+/**
+ * Link definition for connecting steps in MoveOrderFromSupplyToCancelled
+ */
+export interface MoveOrderFromSupplyToCancelledStepLink {
+    /**
+     * The stepKey of the target step to link TO
+     * Must reference another step's stepKey in the same flow
+     */
+    stepKey: string;
+    /**
+     * The schema association ID (UUID) defining the relationship
+     * Use the association.id from the schema association definition
+     * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+     */
+    schemaAssociationId: string;
+}
+/**
+ * Step definition with linking metadata for MoveOrderFromSupplyToCancelled
+ */
+export interface MoveOrderFromSupplyToCancelledStepDefinition {
+    /** Unique identifier for this step */
+    stepKey: string;
+    /** The DTO class name for this step */
+    dtoClass: string;
+    /** The entity this step creates (Module:Entity format) */
+    entity: string;
+    /** Links to create after this step executes */
+    linksTo: MoveOrderFromSupplyToCancelledStepLink[] | null;
+}
+/**
+ * Type-safe step keys for MoveOrderFromSupplyToCancelled
+ */
+export declare const MoveOrderFromSupplyToCancelledSteps: {
+    readonly step_1: "step_1";
+};
+export declare type MoveOrderFromSupplyToCancelledStepKey = typeof MoveOrderFromSupplyToCancelledSteps[keyof typeof MoveOrderFromSupplyToCancelledSteps];
+/**
+ * RabbitMQ message payload for MoveOrderFromSupplyToCancelled step flow events
+ *
+ * @event k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToCancelled
+ */
+export interface MoveOrderFromSupplyToCancelledMessage extends OdinRecordUpdatedEvent<MoveOrderFromSupplyToCancelledDto, {}> {
+}
+/**
+ * Properties for MoveOrderFromSupplyToCancelled action
+ *
+ */
+export interface MoveOrderFromSupplyToCancelledProperties {
+}
+/**
+ * MoveOrderFromSupplyToCancelled
+ *
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
+ * @module OrderModule
+ * @entity Order
+ * @targetStages OrderStageCancelled
+ * @event k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToCancelled
+ * @permission schema.action.moveorderfromsupplytocancelled.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class MoveOrderFromSupplyToCancelledDto extends OdinRecordUpdateDto<Record<string, any>> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "MoveOrderFromSupplyToCancelled";
+    static readonly MODULE_NAME = "OrderModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToCancelled";
+    static readonly SCHEMA_ACTION_ID = "5f0e17fb-63a5-4857-a66b-d7c5274f1a81";
+    static readonly PERMISSION = "schema.action.moveorderfromsupplytocancelled.trigger";
+    static readonly TARGET_STAGES: readonly ["OrderStageCancelled"];
+    static readonly IS_STAGE_TRANSITION = true;
+    static readonly IS_MULTI_STEP_FLOW = false;
+    static readonly HAS_STEP_LINKS = false;
+    /**
+     * Step definitions with linking metadata
+     * Used by SDK and backend for auto-linking after step execution
+     */
+    static readonly stepDefinitions: MoveOrderFromSupplyToCancelledStepDefinition[];
+    /** Type-safe step key accessor */
+    static readonly Steps: {
+        readonly step_1: "step_1";
+    };
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    readonly stageKey: string;
+    constructor(record: OdinRecord<any> | {
+        id: string;
+        entity: string;
+        type?: string;
+    }, options?: {
+        journeyId?: string;
+    });
+    /** Step classes that can be used with this action */
+    static readonly stepClasses: readonly [];
+    steps: StepClassMap[(typeof MoveOrderFromSupplyToCancelledDto.stepClasses)[number]][];
+}
+export {};

package/dist/actions-v2/MoveOrderFromSupplyToCancelledDto.js

@@ -0,0 +1,77 @@
+"use strict";
+/**
+ * MoveOrderFromSupplyToCancelled Action DTO
+ *
+ * MoveOrderFromSupplyToCancelled
+ *
+ * @module OrderModule
+ * @entity Order
+ * @actionKey MoveOrderFromSupplyToCancelled
+ * @event k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToCancelled
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MoveOrderFromSupplyToCancelledDto = exports.MoveOrderFromSupplyToCancelledSteps = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Type-safe step keys for MoveOrderFromSupplyToCancelled
+ */
+exports.MoveOrderFromSupplyToCancelledSteps = {
+    step_1: 'step_1',
+};
+/**
+ * MoveOrderFromSupplyToCancelled
+ *
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
+ * @module OrderModule
+ * @entity Order
+ * @targetStages OrderStageCancelled
+ * @event k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToCancelled
+ * @permission schema.action.moveorderfromsupplytocancelled.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class MoveOrderFromSupplyToCancelledDto extends core_1.OdinRecordUpdateDto {
+    constructor(record, options) {
+        super({
+            id: record.id,
+            entity: record.entity,
+            type: record.type,
+            properties: {},
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+        });
+        this.actionName = 'MoveOrderFromSupplyToCancelled';
+        this.schemaActionId = '5f0e17fb-63a5-4857-a66b-d7c5274f1a81';
+        this.entity = 'OrderModule:Order';
+        this.stageKey = 'OrderStageCancelled';
+    }
+}
+exports.MoveOrderFromSupplyToCancelledDto = MoveOrderFromSupplyToCancelledDto;
+/** Used by SDK generators to identify action type */
+MoveOrderFromSupplyToCancelledDto.ACTION_TYPE = 'UPDATE';
+MoveOrderFromSupplyToCancelledDto.ACTION_KEY = 'MoveOrderFromSupplyToCancelled';
+MoveOrderFromSupplyToCancelledDto.MODULE_NAME = 'OrderModule';
+MoveOrderFromSupplyToCancelledDto.ENTITIES = ['Order'];
+MoveOrderFromSupplyToCancelledDto.EVENT_NAME = 'k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToCancelled';
+MoveOrderFromSupplyToCancelledDto.SCHEMA_ACTION_ID = '5f0e17fb-63a5-4857-a66b-d7c5274f1a81';
+MoveOrderFromSupplyToCancelledDto.PERMISSION = 'schema.action.moveorderfromsupplytocancelled.trigger';
+MoveOrderFromSupplyToCancelledDto.TARGET_STAGES = ['OrderStageCancelled'];
+MoveOrderFromSupplyToCancelledDto.IS_STAGE_TRANSITION = true;
+MoveOrderFromSupplyToCancelledDto.IS_MULTI_STEP_FLOW = false;
+MoveOrderFromSupplyToCancelledDto.HAS_STEP_LINKS = false;
+/**
+ * Step definitions with linking metadata
+ * Used by SDK and backend for auto-linking after step execution
+ */
+MoveOrderFromSupplyToCancelledDto.stepDefinitions = [
+    {
+        stepKey: 'step_1',
+        dtoClass: 'unknown',
+        entity: 'unknown',
+        linksTo: null
+    }
+];
+/** Type-safe step key accessor */
+MoveOrderFromSupplyToCancelledDto.Steps = exports.MoveOrderFromSupplyToCancelledSteps;
+/** Step classes that can be used with this action */
+MoveOrderFromSupplyToCancelledDto.stepClasses = [];

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

@@ -127,6 +127,8 @@ export declare enum AccountCreditPropertyKeys {
     Description = "Description",
     /** Reason */
     Reason = "Reason",
+    /** Brsk reference */
+    ExternalReference = "ExternalReference",
     /** Credit Balance */
     CreditBalance = "CreditBalance",
     /** Contact */
@@ -157,6 +159,11 @@ export interface AccountCreditProperties {
      * @enum {AccountCreditReason}
      */
     Reason: AccountCreditReason;
+    /** Brsk reference
+     *
+     * @type {TEXT}
+     */
+    ExternalReference: string;
     /** Credit Balance
      *
      * @type {CURRENCY}

package/dist/entities-v2/AccountCredit.js

@@ -134,6 +134,8 @@ var AccountCreditPropertyKeys;
     AccountCreditPropertyKeys["Description"] = "Description";
     /** Reason */
     AccountCreditPropertyKeys["Reason"] = "Reason";
+    /** Brsk reference */
+    AccountCreditPropertyKeys["ExternalReference"] = "ExternalReference";
     /** Credit Balance */
     AccountCreditPropertyKeys["CreditBalance"] = "CreditBalance";
     /** Contact */

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

@@ -23,12 +23,12 @@ export declare enum ConfigEntityTypes {
  * Use these constants instead of string literals for type safety
  */
 export declare enum ConfigPropertyKeys {
-    /** Data field for Config records. Used by Platform team. */
-    Test = "Test",
+    /** the name of the app this config relates to (Platform - Config) */
+    AppName = "AppName",
     /** object of { key: value } mappings (Platform - Config) */
     Mappings = "Mappings",
-    /** the name of the app this config relates to (Platform - Config) */
-    AppName = "AppName"
+    /** Data field for Config records. Used by Platform team. */
+    Test = "Test"
 }
 /**
  * Properties for Config records
@@ -36,21 +36,21 @@ export declare enum ConfigPropertyKeys {
  * @see SchemaModule:Config
  */
 export interface ConfigProperties {
-    /** Data field for Config records. Used by Platform team.
+    /** the name of the app this config relates to (Platform - Config)
      *
      * @type {TEXT}
      */
-    Test: string;
+    AppName: string;
     /** object of { key: value } mappings (Platform - Config)
      *
      * @type {JSON}
      */
     Mappings: string;
-    /** the name of the app this config relates to (Platform - Config)
+    /** Data field for Config records. Used by Platform team.
      *
      * @type {TEXT}
      */
-    AppName: string;
+    Test: string;
 }
 /**
  * Config entity from SchemaModule

package/dist/entities-v2/Config.js

@@ -28,12 +28,12 @@ var ConfigEntityTypes;
  */
 var ConfigPropertyKeys;
 (function (ConfigPropertyKeys) {
-    /** Data field for Config records. Used by Platform team. */
-    ConfigPropertyKeys["Test"] = "Test";
-    /** object of { key: value } mappings (Platform - Config) */
-    ConfigPropertyKeys["Mappings"] = "Mappings";
     /** the name of the app this config relates to (Platform - Config) */
     ConfigPropertyKeys["AppName"] = "AppName";
+    /** object of { key: value } mappings (Platform - Config) */
+    ConfigPropertyKeys["Mappings"] = "Mappings";
+    /** Data field for Config records. Used by Platform team. */
+    ConfigPropertyKeys["Test"] = "Test";
 })(ConfigPropertyKeys = exports.ConfigPropertyKeys || (exports.ConfigPropertyKeys = {}));
 /**
  * Config entity from SchemaModule

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

@@ -131,6 +131,8 @@ export declare enum PaymentMethodPropertyKeys {
     Provider = "Provider",
     /** 2 or 4 ending digits of the bank account number (Finance - PaymentMethod) */
     BankAccountNumberEnding = "BankAccountNumberEnding",
+    /** ExternalRefBrskISP */
+    ExternalRefBrskIsp = "ExternalRefBrskISP",
     /** This is a private field used for creating a new payment method, no data is stored here. (Finance - PaymentMethod) */
     BranchCode = "_BranchCode",
     /** Private field use for forms creating the payment method. No data is stored here. (Finance - PaymentMethod) */
@@ -221,6 +223,11 @@ export interface PaymentMethodProperties {
      * @hidden This field is hidden in the UI
      */
     BankAccountNumberEnding: string;
+    /** ExternalRefBrskISP
+     *
+     * @type {TEXT}
+     */
+    ExternalRefBrskIsp: string;
     /** This is a private field used for creating a new payment method, no data is stored here. (Finance - PaymentMethod)
      *
      * @type {TEXT}

package/dist/entities-v2/PaymentMethod.js

@@ -132,6 +132,8 @@ var PaymentMethodPropertyKeys;
     PaymentMethodPropertyKeys["Provider"] = "Provider";
     /** 2 or 4 ending digits of the bank account number (Finance - PaymentMethod) */
     PaymentMethodPropertyKeys["BankAccountNumberEnding"] = "BankAccountNumberEnding";
+    /** ExternalRefBrskISP */
+    PaymentMethodPropertyKeys["ExternalRefBrskIsp"] = "ExternalRefBrskISP";
     /** This is a private field used for creating a new payment method, no data is stored here. (Finance - PaymentMethod) */
     PaymentMethodPropertyKeys["BranchCode"] = "_BranchCode";
     /** Private field use for forms creating the payment method. No data is stored here. (Finance - PaymentMethod) */

package/dist/records-v2/OrderRecord.d.ts

@@ -1830,6 +1830,31 @@ export declare class OrderRecord<TProps = OrderProperties> {
     moveOrderFromPreOrderToCancelled(options?: {
         journeyId?: string;
     }): ActionBuilder;
+    /**
+     * MoveOrderFromSupplyToCancelled
+     *
+     * Transitions this Order record to a new pipeline stage.
+     * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
+     *
+     * @remarks Transitions to stage: OrderStageCancelled
+     *
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.orders.get(id);
+     * await record.moveOrderFromSupplyToCancelled().execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.moveOrderFromSupplyToCancelled().dryRun();
+     * ```
+     */
+    moveOrderFromSupplyToCancelled(options?: {
+        journeyId?: string;
+    }): ActionBuilder;
     /**
      * MoveOrderToActive
      *

package/dist/records-v2/OrderRecord.js

@@ -2636,6 +2636,35 @@ class OrderRecord {
         const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MoveOrderFromPreOrderToCancelled', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'OrderStageCancelled' }, options);
         return new ActionBuilder(this._provider, 'OrderModule', 'Order', payload, () => { this._pendingLinks = []; });
     }
+    /**
+     * MoveOrderFromSupplyToCancelled
+     *
+     * Transitions this Order record to a new pipeline stage.
+     * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
+     *
+     * @remarks Transitions to stage: OrderStageCancelled
+     *
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.orders.get(id);
+     * await record.moveOrderFromSupplyToCancelled().execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.moveOrderFromSupplyToCancelled().dryRun();
+     * ```
+     */
+    moveOrderFromSupplyToCancelled(options) {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('moveOrderFromSupplyToCancelled requires an existing record. Use accessor.get() first.');
+        const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MoveOrderFromSupplyToCancelled', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'OrderStageCancelled' }, options);
+        return new ActionBuilder(this._provider, 'OrderModule', 'Order', payload, () => { this._pendingLinks = []; });
+    }
     /**
      * MoveOrderToActive
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d19n/youfibre-odin-sdk",
-  "version": "2.0.49",
+  "version": "2.0.51-beta.0",
   "description": "",
   "author": "@d19n",
   "license": "UNLICENSED",
@@ -11,7 +11,7 @@
     "typescript": "4.8.4"
   },
   "dependencies": {
-    "@d19n/odin-sdk-generator": "^3.0.234",
+    "@d19n/odin-sdk-generator": "^3.0.235",
     "@d19n/odin-types": "^3.0.31"
   },
   "scripts": {