@d19n/youfibre-odin-sdk 2.0.286 → 2.0.287

package/README.md

@@ -366,7 +366,7 @@ This SDK includes **178** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **846** actions.
+This SDK includes **847** actions.
 
 ### Action Types
 
@@ -522,6 +522,7 @@ This SDK includes **846** actions.
 | `MoveCollectionAmcoToFailedInspection` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToFailedInspection |
 | `MoveCollectionAmcoToOverridden` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToOverridden |
 | `MoveCollectionAmcoToPendingInspection` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingInspection |
+| `MoveCollectionAmcoToPendingPayment` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment |
 | `MoveCollectionAmcoToPendingReturn` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingReturn |
 | `MoveCollectionAmcoToReceived` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToReceived |
 | `MoveCollectionWorkOrderFromAcceptedToEnRoute` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.FlowStepEnRouteCollectionConfirmation |
@@ -665,6 +666,8 @@ This SDK includes **846** actions.
 
 **MoveCollectionAmcoToPendingInspection Target Stages:** `CollectionAmcoStagePendingInspection`
 
+**MoveCollectionAmcoToPendingPayment Target Stages:** `CollectionAmcoStagePendingPayment`
+
 **MoveCollectionAmcoToPendingReturn Target Stages:** `CollectionAmcoStagePendingReturn`
 
 **MoveCollectionAmcoToReceived Target Stages:** `CollectionAmcoStageReceived`

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

@@ -0,0 +1,70 @@
+/**
+ * MoveCollectionAmcoToPendingPayment Action DTO
+ *
+ * Move the collection work order to Pending Payment.
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO
+ * @actionKey MoveCollectionAmcoToPendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for MoveCollectionAmcoToPendingPayment step flow events
+ *
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment
+ */
+export interface MoveCollectionAmcoToPendingPaymentMessage extends OdinRecordUpdatedEvent<MoveCollectionAmcoToPendingPaymentDto, {}> {
+}
+/**
+ * Properties for MoveCollectionAmcoToPendingPayment action
+ *
+ */
+export interface MoveCollectionAmcoToPendingPaymentProperties {
+}
+/**
+ * MoveCollectionAmcoToPendingPayment
+ *
+ * Move the collection work order to Pending Payment.
+ *
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO ( 3PL Collection)
+ * @targetStages CollectionAmcoStagePendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment
+ * @permission schema.action.movecollectionamcotopendingpayment.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class MoveCollectionAmcoToPendingPaymentDto extends OdinRecordUpdateDto<Record<string, any>> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "MoveCollectionAmcoToPendingPayment";
+    static readonly MODULE_NAME = "FieldServiceModule";
+    static readonly ENTITIES: string[];
+    static readonly ENTITY_TYPE = "COLLECTION_AMCO";
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment";
+    static readonly SCHEMA_ACTION_ID = "2136c985-8f01-4ca8-a265-4b73ae810f7e";
+    static readonly PERMISSION = "schema.action.movecollectionamcotopendingpayment.trigger";
+    static readonly TARGET_STAGES: readonly ["CollectionAmcoStagePendingPayment"];
+    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/MoveCollectionAmcoToPendingPaymentDto.js

@@ -0,0 +1,62 @@
+"use strict";
+/**
+ * MoveCollectionAmcoToPendingPayment Action DTO
+ *
+ * Move the collection work order to Pending Payment.
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO
+ * @actionKey MoveCollectionAmcoToPendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MoveCollectionAmcoToPendingPaymentDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * MoveCollectionAmcoToPendingPayment
+ *
+ * Move the collection work order to Pending Payment.
+ *
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO ( 3PL Collection)
+ * @targetStages CollectionAmcoStagePendingPayment
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment
+ * @permission schema.action.movecollectionamcotopendingpayment.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class MoveCollectionAmcoToPendingPaymentDto 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 = 'MoveCollectionAmcoToPendingPayment';
+        this.schemaActionId = '2136c985-8f01-4ca8-a265-4b73ae810f7e';
+        this.entity = 'FieldServiceModule:WorkOrder';
+        this.stageKey = 'CollectionAmcoStagePendingPayment';
+    }
+}
+exports.MoveCollectionAmcoToPendingPaymentDto = MoveCollectionAmcoToPendingPaymentDto;
+/** Used by SDK generators to identify action type */
+MoveCollectionAmcoToPendingPaymentDto.ACTION_TYPE = 'UPDATE';
+MoveCollectionAmcoToPendingPaymentDto.ACTION_KEY = 'MoveCollectionAmcoToPendingPayment';
+MoveCollectionAmcoToPendingPaymentDto.MODULE_NAME = 'FieldServiceModule';
+MoveCollectionAmcoToPendingPaymentDto.ENTITIES = ['WorkOrder'];
+MoveCollectionAmcoToPendingPaymentDto.ENTITY_TYPE = 'COLLECTION_AMCO';
+MoveCollectionAmcoToPendingPaymentDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveCollectionAmcoToPendingPayment';
+MoveCollectionAmcoToPendingPaymentDto.SCHEMA_ACTION_ID = '2136c985-8f01-4ca8-a265-4b73ae810f7e';
+MoveCollectionAmcoToPendingPaymentDto.PERMISSION = 'schema.action.movecollectionamcotopendingpayment.trigger';
+MoveCollectionAmcoToPendingPaymentDto.TARGET_STAGES = ['CollectionAmcoStagePendingPayment'];
+MoveCollectionAmcoToPendingPaymentDto.IS_STAGE_TRANSITION = true;
+MoveCollectionAmcoToPendingPaymentDto.IS_MULTI_STEP_FLOW = false;
+MoveCollectionAmcoToPendingPaymentDto.HAS_STEP_LINKS = false;
+/** Step classes that can be used with this action */
+MoveCollectionAmcoToPendingPaymentDto.stepClasses = [];

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

@@ -164,7 +164,9 @@ export declare enum CollectionAmcoWorkOrderStageNames {
     /** Failed Inspection (fail) */
     FailedInspection = "Failed Inspection",
     /** Not returned after X days */
-    NonReturned = "Non Returned"
+    NonReturned = "Non Returned",
+    /** Equipment was never returned and is being recovered as a charge; awaiting payment. */
+    PendingPayment = "Pending Payment"
 }
 /**
  * Pipeline stage keys for COLLECTION_AMCO WorkOrder
@@ -190,7 +192,9 @@ export declare enum CollectionAmcoWorkOrderStageKeys {
     /** Failed Inspection */
     CollectionAmcoStageFailedInspection = "CollectionAmcoStageFailedInspection",
     /** Not returned after X days */
-    CollectionAmcoStageNonReturned = "CollectionAmcoStageNonReturned"
+    CollectionAmcoStageNonReturned = "CollectionAmcoStageNonReturned",
+    /** Equipment was never returned and is being recovered as a charge; awaiting payment. */
+    CollectionAmcoStagePendingPayment = "CollectionAmcoStagePendingPayment"
 }
 /**
  * Pipeline stage names for DISPATCH_AMCO WorkOrder

package/dist/entities-v2/WorkOrder.js

@@ -116,6 +116,8 @@ var CollectionAmcoWorkOrderStageNames;
     CollectionAmcoWorkOrderStageNames["FailedInspection"] = "Failed Inspection";
     /** Not returned after X days */
     CollectionAmcoWorkOrderStageNames["NonReturned"] = "Non Returned";
+    /** Equipment was never returned and is being recovered as a charge; awaiting payment. */
+    CollectionAmcoWorkOrderStageNames["PendingPayment"] = "Pending Payment";
 })(CollectionAmcoWorkOrderStageNames = exports.CollectionAmcoWorkOrderStageNames || (exports.CollectionAmcoWorkOrderStageNames = {}));
 /**
  * Pipeline stage keys for COLLECTION_AMCO WorkOrder
@@ -143,6 +145,8 @@ var CollectionAmcoWorkOrderStageKeys;
     CollectionAmcoWorkOrderStageKeys["CollectionAmcoStageFailedInspection"] = "CollectionAmcoStageFailedInspection";
     /** Not returned after X days */
     CollectionAmcoWorkOrderStageKeys["CollectionAmcoStageNonReturned"] = "CollectionAmcoStageNonReturned";
+    /** Equipment was never returned and is being recovered as a charge; awaiting payment. */
+    CollectionAmcoWorkOrderStageKeys["CollectionAmcoStagePendingPayment"] = "CollectionAmcoStagePendingPayment";
 })(CollectionAmcoWorkOrderStageKeys = exports.CollectionAmcoWorkOrderStageKeys || (exports.CollectionAmcoWorkOrderStageKeys = {}));
 /**
  * Pipeline stage names for DISPATCH_AMCO WorkOrder

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

@@ -5428,6 +5428,31 @@ export declare class WorkOrderRecord<TProps = WorkOrderProperties> {
     moveCollectionAmcoToPendingInspection(options?: {
         journeyId?: string;
     }): ActionBuilder;
+    /**
+     * MoveCollectionAmcoToPendingPayment
+     *
+     * Transitions this WorkOrder record to a new pipeline stage.
+     * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
+     *
+     * @remarks Transitions to stage: CollectionAmcoStagePendingPayment
+     *
+     * @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.moveCollectionAmcoToPendingPayment().execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.moveCollectionAmcoToPendingPayment().dryRun();
+     * ```
+     */
+    moveCollectionAmcoToPendingPayment(options?: {
+        journeyId?: string;
+    }): ActionBuilder;
     /**
      * MoveCollectionAmcoToPendingReturn
      *

package/dist/records-v2/WorkOrderRecord.js

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

package/package.json

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