@d19n/youfibre-odin-sdk 2.0.388 → 2.0.390

package/README.md

@@ -406,7 +406,7 @@ This SDK includes **213** entities across **13** modules.
 
 ## Actions
 
-This SDK includes **952** actions.
+This SDK includes **953** actions.
 
 ### Action Types
 
@@ -629,6 +629,7 @@ This SDK includes **952** actions.
 | `MoveReplacementAmcoToFailedInspection` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToFailedInspection |
 | `MoveReplacementAmcoToNonReturned` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToNonReturned |
 | `MoveReplacementAmcoToPendingInspection` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingInspection |
+| `MoveReplacementAmcoToPendingPayment` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingPayment |
 | `MoveReplacementAmcoToPendingReturn` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingReturn |
 | `MoveReplacementAmcoToProcessed` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToProcessed |
 | `MoveReplacementAmcoToReceived` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToReceived |
@@ -840,6 +841,8 @@ This SDK includes **952** actions.
 
 **MoveReplacementAmcoToPendingInspection Target Stages:** `ReplacementAmcoStagePendingInspection`
 
+**MoveReplacementAmcoToPendingPayment Target Stages:** `ReplacementAmcoStagePendingPayment`
+
 **MoveReplacementAmcoToPendingReturn Target Stages:** `ReplacementAmcoStagePendingReturn`
 
 **MoveReplacementAmcoToProcessed Target Stages:** `ReplacementAmcoStageProcessed`

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

@@ -0,0 +1,70 @@
+/**
+ * MoveReplacementAmcoToPendingPayment Action DTO
+ *
+ * Move the replacement work order to Pending Payment.
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType REPLACEMENT_AMCO
+ * @actionKey MoveReplacementAmcoToPendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingPayment
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for MoveReplacementAmcoToPendingPayment step flow events
+ *
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingPayment
+ */
+export interface MoveReplacementAmcoToPendingPaymentMessage extends OdinRecordUpdatedEvent<MoveReplacementAmcoToPendingPaymentDto, {}> {
+}
+/**
+ * Properties for MoveReplacementAmcoToPendingPayment action
+ *
+ */
+export interface MoveReplacementAmcoToPendingPaymentProperties {
+}
+/**
+ * MoveReplacementAmcoToPendingPayment
+ *
+ * Move the replacement work order to Pending Payment.
+ *
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType REPLACEMENT_AMCO (Amco Replacement)
+ * @targetStages ReplacementAmcoStagePendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingPayment
+ * @permission schema.action.movereplacementamcotopendingpayment.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class MoveReplacementAmcoToPendingPaymentDto extends OdinRecordUpdateDto<Record<string, any>> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "MoveReplacementAmcoToPendingPayment";
+    static readonly MODULE_NAME = "FieldServiceModule";
+    static readonly ENTITIES: string[];
+    static readonly ENTITY_TYPE = "REPLACEMENT_AMCO";
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingPayment";
+    static readonly SCHEMA_ACTION_ID = "93e28ad9-8c0f-487e-ade9-deeb0c73d6df";
+    static readonly PERMISSION = "schema.action.movereplacementamcotopendingpayment.trigger";
+    static readonly TARGET_STAGES: readonly ["ReplacementAmcoStagePendingPayment"];
+    static readonly IS_STAGE_TRANSITION = true;
+    static readonly IS_MULTI_STEP_FLOW = false;
+    static readonly HAS_STEP_LINKS = false;
+    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: [];
+}

package/dist/actions-v2/MoveReplacementAmcoToPendingPaymentDto.js

@@ -0,0 +1,62 @@
+"use strict";
+/**
+ * MoveReplacementAmcoToPendingPayment Action DTO
+ *
+ * Move the replacement work order to Pending Payment.
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType REPLACEMENT_AMCO
+ * @actionKey MoveReplacementAmcoToPendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingPayment
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MoveReplacementAmcoToPendingPaymentDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * MoveReplacementAmcoToPendingPayment
+ *
+ * Move the replacement work order to Pending Payment.
+ *
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType REPLACEMENT_AMCO (Amco Replacement)
+ * @targetStages ReplacementAmcoStagePendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingPayment
+ * @permission schema.action.movereplacementamcotopendingpayment.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class MoveReplacementAmcoToPendingPaymentDto 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 = 'MoveReplacementAmcoToPendingPayment';
+        this.schemaActionId = '93e28ad9-8c0f-487e-ade9-deeb0c73d6df';
+        this.entity = 'FieldServiceModule:WorkOrder';
+        this.stageKey = 'ReplacementAmcoStagePendingPayment';
+    }
+}
+exports.MoveReplacementAmcoToPendingPaymentDto = MoveReplacementAmcoToPendingPaymentDto;
+/** Used by SDK generators to identify action type */
+MoveReplacementAmcoToPendingPaymentDto.ACTION_TYPE = 'UPDATE';
+MoveReplacementAmcoToPendingPaymentDto.ACTION_KEY = 'MoveReplacementAmcoToPendingPayment';
+MoveReplacementAmcoToPendingPaymentDto.MODULE_NAME = 'FieldServiceModule';
+MoveReplacementAmcoToPendingPaymentDto.ENTITIES = ['WorkOrder'];
+MoveReplacementAmcoToPendingPaymentDto.ENTITY_TYPE = 'REPLACEMENT_AMCO';
+MoveReplacementAmcoToPendingPaymentDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingPayment';
+MoveReplacementAmcoToPendingPaymentDto.SCHEMA_ACTION_ID = '93e28ad9-8c0f-487e-ade9-deeb0c73d6df';
+MoveReplacementAmcoToPendingPaymentDto.PERMISSION = 'schema.action.movereplacementamcotopendingpayment.trigger';
+MoveReplacementAmcoToPendingPaymentDto.TARGET_STAGES = ['ReplacementAmcoStagePendingPayment'];
+MoveReplacementAmcoToPendingPaymentDto.IS_STAGE_TRANSITION = true;
+MoveReplacementAmcoToPendingPaymentDto.IS_MULTI_STEP_FLOW = false;
+MoveReplacementAmcoToPendingPaymentDto.HAS_STEP_LINKS = false;
+/** Step classes that can be used with this action */
+MoveReplacementAmcoToPendingPaymentDto.stepClasses = [];

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

@@ -41,7 +41,11 @@ export declare enum RouterPingSnapshotPropertyKeys {
     /** Average round-trip time of the answered pings. */
     AverageResponseTimeMs = "AverageResponseTimeMs",
     /** Why the ping could not run. Empty when it ran. */
-    Error = "Error"
+    Error = "Error",
+    /** Fastest round-trip time of the answered pings. */
+    MinimumResponseTimeMs = "MinimumResponseTimeMs",
+    /** Slowest round-trip time of the answered pings. */
+    MaximumResponseTimeMs = "MaximumResponseTimeMs"
 }
 /**
  * Properties for RouterPingSnapshot records
@@ -103,6 +107,18 @@ export interface RouterPingSnapshotProperties {
      * @default
      */
     Error: string;
+    /** Fastest round-trip time of the answered pings.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    MinimumResponseTimeMs: number;
+    /** Slowest round-trip time of the answered pings.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    MaximumResponseTimeMs: number;
 }
 /**
  * RouterPingSnapshot entity from ServiceModule

package/dist/entities-v2/RouterPingSnapshot.js

@@ -46,6 +46,10 @@ var RouterPingSnapshotPropertyKeys;
     RouterPingSnapshotPropertyKeys["AverageResponseTimeMs"] = "AverageResponseTimeMs";
     /** Why the ping could not run. Empty when it ran. */
     RouterPingSnapshotPropertyKeys["Error"] = "Error";
+    /** Fastest round-trip time of the answered pings. */
+    RouterPingSnapshotPropertyKeys["MinimumResponseTimeMs"] = "MinimumResponseTimeMs";
+    /** Slowest round-trip time of the answered pings. */
+    RouterPingSnapshotPropertyKeys["MaximumResponseTimeMs"] = "MaximumResponseTimeMs";
 })(RouterPingSnapshotPropertyKeys = exports.RouterPingSnapshotPropertyKeys || (exports.RouterPingSnapshotPropertyKeys = {}));
 /**
  * RouterPingSnapshot entity from ServiceModule

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

@@ -626,7 +626,9 @@ export declare enum ReplacementAmcoWorkOrderStageNames {
     /** Complete (success) */
     Complete = "Complete",
     /** Failed Delivery (fail) */
-    FailedDelivery = "Failed Delivery"
+    FailedDelivery = "Failed Delivery",
+    /** Equipment was never returned and is being recovered as a charge; awaiting payment. */
+    PendingPayment = "Pending Payment"
 }
 /**
  * Pipeline stage keys for REPLACEMENT_AMCO WorkOrder
@@ -658,7 +660,9 @@ export declare enum ReplacementAmcoWorkOrderStageKeys {
     /** Complete */
     ReplacementAmcoStageComplete = "ReplacementAmcoStageComplete",
     /** Failed Delivery */
-    ReplacementAmcoStageFailedDelivery = "ReplacementAmcoStageFailedDelivery"
+    ReplacementAmcoStageFailedDelivery = "ReplacementAmcoStageFailedDelivery",
+    /** Equipment was never returned and is being recovered as a charge; awaiting payment. */
+    ReplacementAmcoStagePendingPayment = "ReplacementAmcoStagePendingPayment"
 }
 /**
  * Pipeline stage names for SERVICE WorkOrder

package/dist/entities-v2/WorkOrder.js

@@ -592,6 +592,8 @@ var ReplacementAmcoWorkOrderStageNames;
     ReplacementAmcoWorkOrderStageNames["Complete"] = "Complete";
     /** Failed Delivery (fail) */
     ReplacementAmcoWorkOrderStageNames["FailedDelivery"] = "Failed Delivery";
+    /** Equipment was never returned and is being recovered as a charge; awaiting payment. */
+    ReplacementAmcoWorkOrderStageNames["PendingPayment"] = "Pending Payment";
 })(ReplacementAmcoWorkOrderStageNames = exports.ReplacementAmcoWorkOrderStageNames || (exports.ReplacementAmcoWorkOrderStageNames = {}));
 /**
  * Pipeline stage keys for REPLACEMENT_AMCO WorkOrder
@@ -625,6 +627,8 @@ var ReplacementAmcoWorkOrderStageKeys;
     ReplacementAmcoWorkOrderStageKeys["ReplacementAmcoStageComplete"] = "ReplacementAmcoStageComplete";
     /** Failed Delivery */
     ReplacementAmcoWorkOrderStageKeys["ReplacementAmcoStageFailedDelivery"] = "ReplacementAmcoStageFailedDelivery";
+    /** Equipment was never returned and is being recovered as a charge; awaiting payment. */
+    ReplacementAmcoWorkOrderStageKeys["ReplacementAmcoStagePendingPayment"] = "ReplacementAmcoStagePendingPayment";
 })(ReplacementAmcoWorkOrderStageKeys = exports.ReplacementAmcoWorkOrderStageKeys || (exports.ReplacementAmcoWorkOrderStageKeys = {}));
 /**
  * Pipeline stage names for SERVICE WorkOrder

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

@@ -7748,6 +7748,31 @@ export declare class WorkOrderRecord<TProps = WorkOrderProperties> {
     moveReplacementAmcoToPendingInspection(options?: {
         journeyId?: string;
     }): ActionBuilder;
+    /**
+     * MoveReplacementAmcoToPendingPayment
+     *
+     * Transitions this WorkOrder record to a new pipeline stage.
+     * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
+     *
+     * @remarks Transitions to stage: ReplacementAmcoStagePendingPayment
+     *
+     * @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.workOrders.get(id);
+     * await record.moveReplacementAmcoToPendingPayment().execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.moveReplacementAmcoToPendingPayment().dryRun();
+     * ```
+     */
+    moveReplacementAmcoToPendingPayment(options?: {
+        journeyId?: string;
+    }): ActionBuilder;
     /**
      * MoveReplacementAmcoToPendingReturn
      *

package/dist/records-v2/WorkOrderRecord.js

@@ -10897,6 +10897,35 @@ class WorkOrderRecord {
         const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MoveReplacementAmcoToPendingInspection', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'ReplacementAmcoStagePendingInspection' }, options);
         return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
     }
+    /**
+     * MoveReplacementAmcoToPendingPayment
+     *
+     * Transitions this WorkOrder record to a new pipeline stage.
+     * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
+     *
+     * @remarks Transitions to stage: ReplacementAmcoStagePendingPayment
+     *
+     * @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.workOrders.get(id);
+     * await record.moveReplacementAmcoToPendingPayment().execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.moveReplacementAmcoToPendingPayment().dryRun();
+     * ```
+     */
+    moveReplacementAmcoToPendingPayment(options) {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('moveReplacementAmcoToPendingPayment 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: 'MoveReplacementAmcoToPendingPayment', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'ReplacementAmcoStagePendingPayment' }, options);
+        return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
+    }
     /**
      * MoveReplacementAmcoToPendingReturn
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d19n/youfibre-odin-sdk",
-  "version": "2.0.388",
+  "version": "2.0.390",
   "description": "",
   "author": "@d19n",
   "license": "UNLICENSED",