@d19n/youfibre-odin-sdk 2.0.356 → 2.0.358

package/README.md

@@ -394,7 +394,7 @@ This SDK includes **201** entities across **13** modules.
 
 ## Actions
 
-This SDK includes **932** actions.
+This SDK includes **933** actions.
 
 ### Action Types
 
@@ -502,6 +502,7 @@ This SDK includes **932** actions.
 | `CompleteServiceWorkOrderFlow` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.CompleteServiceWorkOrder |
 | `CompleteServiceWorkOrderFlowSupplier` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.CompleteServiceWorkOrderFlowSupplier |
 | `CreateCancelCollectionAmco` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCancelCollectionAmco |
+| `CreateCollectionAmcoFollowOnWorkOrder` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.CreateCollectionAmcoFollowOnWorkOrder |
 | `CreateCollectionAmcoReplacementWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoReplacementWorkOrder |
 | `CreateCollectionAmcoReplacementWorkOrderFromWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoReplacementWorkOrder |
 | `CreateCollectionAmcoWorkOrder` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Create.CreateCollectionAmcoWorkOrder |

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

@@ -0,0 +1,68 @@
+/**
+ * CreateCollectionAmcoFollowOnWorkOrder Action DTO
+ *
+ * Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices, then moves this one to Complete.
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO
+ * @actionKey CreateCollectionAmcoFollowOnWorkOrder
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.CreateCollectionAmcoFollowOnWorkOrder
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for CreateCollectionAmcoFollowOnWorkOrder updated events
+ *
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.CreateCollectionAmcoFollowOnWorkOrder
+ */
+export interface CreateCollectionAmcoFollowOnWorkOrderMessage extends OdinRecordUpdatedEvent<CreateCollectionAmcoFollowOnWorkOrderDto, CreateCollectionAmcoFollowOnWorkOrderProperties> {
+}
+/**
+ * Properties for CreateCollectionAmcoFollowOnWorkOrder action
+ *
+ */
+export interface CreateCollectionAmcoFollowOnWorkOrderProperties {
+}
+/**
+ * Send Another Bag
+ *
+ * Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices, then moves this one to Complete.
+ *
+ * @actionType UPDATE - Updates an existing WorkOrder record
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO ( 3PL Collection)
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.CreateCollectionAmcoFollowOnWorkOrder
+ * @permission schema.action.createcollectionamcofollowonworkorder.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class CreateCollectionAmcoFollowOnWorkOrderDto extends OdinRecordUpdateDto<CreateCollectionAmcoFollowOnWorkOrderProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "UPDATE";
+    static readonly ACTION_KEY = "CreateCollectionAmcoFollowOnWorkOrder";
+    static readonly MODULE_NAME = "FieldServiceModule";
+    static readonly ENTITIES: string[];
+    static readonly ENTITY_TYPE = "COLLECTION_AMCO";
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.CreateCollectionAmcoFollowOnWorkOrder";
+    static readonly PERMISSION = "schema.action.createcollectionamcofollowonworkorder.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "FieldServiceModule:WorkOrder";
+    static readonly STEP_SCHEMA_ID = "966bf5d9-163e-4132-85e2-56a5f801c9de";
+    static readonly STEP_SCHEMA_ACTION_ID = "faed01ae-c0e8-4c97-b439-edf71dbf492e";
+    static readonly STEP_SCHEMA_TYPE_ID = "0bf773b2-9054-457e-a282-5ae8fdfa7f7c";
+    static readonly STEP_TYPE = "COLLECTION_AMCO";
+    static readonly AUTO_LINK_PARENT = false;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(record: OdinRecord<any> | {
+        id: string;
+        entity: string;
+        type?: string;
+    }, properties: CreateCollectionAmcoFollowOnWorkOrderProperties, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    });
+}

package/dist/actions-v2/CreateCollectionAmcoFollowOnWorkOrderDto.js

@@ -0,0 +1,61 @@
+"use strict";
+/**
+ * CreateCollectionAmcoFollowOnWorkOrder Action DTO
+ *
+ * Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices, then moves this one to Complete.
+ *
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO
+ * @actionKey CreateCollectionAmcoFollowOnWorkOrder
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.CreateCollectionAmcoFollowOnWorkOrder
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCollectionAmcoFollowOnWorkOrderDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Send Another Bag
+ *
+ * Send the customer another bag for the devices a failed inspection found missing. Creates a linked 3PL collection for only those devices, then moves this one to Complete.
+ *
+ * @actionType UPDATE - Updates an existing WorkOrder record
+ * @module FieldServiceModule
+ * @entity WorkOrder
+ * @entityType COLLECTION_AMCO ( 3PL Collection)
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.CreateCollectionAmcoFollowOnWorkOrder
+ * @permission schema.action.createcollectionamcofollowonworkorder.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class CreateCollectionAmcoFollowOnWorkOrderDto 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 = 'CreateCollectionAmcoFollowOnWorkOrder';
+        this.schemaActionId = 'faed01ae-c0e8-4c97-b439-edf71dbf492e';
+        this.entity = 'FieldServiceModule:WorkOrder';
+    }
+}
+exports.CreateCollectionAmcoFollowOnWorkOrderDto = CreateCollectionAmcoFollowOnWorkOrderDto;
+/** Used by SDK generators to identify action type */
+CreateCollectionAmcoFollowOnWorkOrderDto.ACTION_TYPE = 'UPDATE';
+CreateCollectionAmcoFollowOnWorkOrderDto.ACTION_KEY = 'CreateCollectionAmcoFollowOnWorkOrder';
+CreateCollectionAmcoFollowOnWorkOrderDto.MODULE_NAME = 'FieldServiceModule';
+CreateCollectionAmcoFollowOnWorkOrderDto.ENTITIES = ['WorkOrder'];
+CreateCollectionAmcoFollowOnWorkOrderDto.ENTITY_TYPE = 'COLLECTION_AMCO';
+CreateCollectionAmcoFollowOnWorkOrderDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Update.CreateCollectionAmcoFollowOnWorkOrder';
+CreateCollectionAmcoFollowOnWorkOrderDto.PERMISSION = 'schema.action.createcollectionamcofollowonworkorder.trigger';
+/** Step metadata - entity this action targets */
+CreateCollectionAmcoFollowOnWorkOrderDto.STEP_ENTITY = 'FieldServiceModule:WorkOrder';
+CreateCollectionAmcoFollowOnWorkOrderDto.STEP_SCHEMA_ID = '966bf5d9-163e-4132-85e2-56a5f801c9de';
+CreateCollectionAmcoFollowOnWorkOrderDto.STEP_SCHEMA_ACTION_ID = 'faed01ae-c0e8-4c97-b439-edf71dbf492e';
+CreateCollectionAmcoFollowOnWorkOrderDto.STEP_SCHEMA_TYPE_ID = '0bf773b2-9054-457e-a282-5ae8fdfa7f7c';
+CreateCollectionAmcoFollowOnWorkOrderDto.STEP_TYPE = 'COLLECTION_AMCO';
+CreateCollectionAmcoFollowOnWorkOrderDto.AUTO_LINK_PARENT = false;

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

@@ -23,7 +23,7 @@ export interface CreateEquipmentReturnItemMessage extends OdinRecordCreatedEvent
  * Properties for CreateEquipmentReturnItem action
  *
  * @property Required fields: 3
- * @property Optional fields: 9
+ * @property Optional fields: 10
  */
 export interface CreateEquipmentReturnItemProperties {
     /**
@@ -113,6 +113,13 @@ export interface CreateEquipmentReturnItemProperties {
      * @type {ENUM}
      */
     Grade?: string | null;
+    /**
+     * Stands In For Device Id
+     *
+     * On an ADDITIONAL row only: the expected device (DeviceId of an EXPECTED row on the same return) this item counted in place of, because that device was not returned and this item is the same kind. Serials are not rewritten; this marks the mismatch so it can be fixed deliberately. Null on every other row
+     * @type {TEXT}
+     */
+    StandsInForDeviceId?: string | null;
 }
 /**
  * Create Equipment Return Item

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

@@ -108,7 +108,9 @@ export declare enum EquipmentReturnItemPropertyKeys {
     /** The tick. Always true on an additional row — it is in the box by definition */
     Returned = "Returned",
     /** Condition as inspected. Same option set as Returns.Cpe{n}Grade. Only meaningful when Returned is true */
-    Grade = "Grade"
+    Grade = "Grade",
+    /** On an ADDITIONAL row only: the expected device (DeviceId of an EXPECTED row on the same return) this item counted in place of, because that device was not returned and this item is the same kind. Serials are not rewritten; this marks the mismatch so it can be fixed deliberately. Null on every other row */
+    StandsInForDeviceId = "StandsInForDeviceId"
 }
 /**
  * Properties for EquipmentReturnItem records
@@ -192,6 +194,12 @@ export interface EquipmentReturnItemProperties {
      * @enum {EquipmentReturnItemGrade}
      */
     Grade: EquipmentReturnItemGrade;
+    /** On an ADDITIONAL row only: the expected device (DeviceId of an EXPECTED row on the same return) this item counted in place of, because that device was not returned and this item is the same kind. Serials are not rewritten; this marks the mismatch so it can be fixed deliberately. Null on every other row
+     *
+     * @type {TEXT}
+     * @default
+     */
+    StandsInForDeviceId: string;
 }
 /**
  * EquipmentReturnItem entity from FieldServiceModule

package/dist/entities-v2/EquipmentReturnItem.js

@@ -114,6 +114,8 @@ var EquipmentReturnItemPropertyKeys;
     EquipmentReturnItemPropertyKeys["Returned"] = "Returned";
     /** Condition as inspected. Same option set as Returns.Cpe{n}Grade. Only meaningful when Returned is true */
     EquipmentReturnItemPropertyKeys["Grade"] = "Grade";
+    /** On an ADDITIONAL row only: the expected device (DeviceId of an EXPECTED row on the same return) this item counted in place of, because that device was not returned and this item is the same kind. Serials are not rewritten; this marks the mismatch so it can be fixed deliberately. Null on every other row */
+    EquipmentReturnItemPropertyKeys["StandsInForDeviceId"] = "StandsInForDeviceId";
 })(EquipmentReturnItemPropertyKeys = exports.EquipmentReturnItemPropertyKeys || (exports.EquipmentReturnItemPropertyKeys = {}));
 /**
  * EquipmentReturnItem entity from FieldServiceModule

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

@@ -41,6 +41,7 @@ import { RemediationOutcomeFormProperties } from '../actions-v2/CompleteRemediat
 import { CompleteServiceWorkOrderProperties } from '../actions-v2/CompleteServiceWorkOrderDto';
 import { CreateYfFieldVisitOutcomeFormProperties } from '../actions-v2/CompleteServiceWorkOrderFlowDto';
 import { CreateCancelCollectionAmcoProperties } from '../actions-v2/CreateCancelCollectionAmcoDto';
+import { CreateCollectionAmcoFollowOnWorkOrderProperties } from '../actions-v2/CreateCollectionAmcoFollowOnWorkOrderDto';
 import { CreateCollectionAmcoReplacementWorkOrderProperties } from '../actions-v2/CreateCollectionAmcoReplacementWorkOrderDto';
 import { CreateCollectionAmcoReplacementWorkOrderBuilder } from '../actions-v2/CreateCollectionAmcoReplacementWorkOrderDto';
 import { CreateCollectionAmcoWorkOrderProperties } from '../actions-v2/CreateCollectionAmcoWorkOrderDto';
@@ -5143,6 +5144,33 @@ export declare class WorkOrderRecord<TProps = WorkOrderProperties> {
     completeServiceWorkOrderFlowSupplier(options?: {
         journeyId?: string;
     }): ActionBuilder;
+    /**
+     * CreateCollectionAmcoFollowOnWorkOrder
+     *
+     * Updates this WorkOrder record.
+     * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
+     *
+     * @param propertiesOrOptions - Properties to update, or options object
+     * @param options - Optional settings (journeyId, stageKey)
+     * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.workOrders.get(id);
+     * await record.createCollectionAmcoFollowOnWorkOrder({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createCollectionAmcoFollowOnWorkOrder({ ... }).dryRun();
+     * ```
+     */
+    createCollectionAmcoFollowOnWorkOrder(propertiesOrOptions?: CreateCollectionAmcoFollowOnWorkOrderProperties | {
+        journeyId?: string;
+        stageKey?: string;
+    }, options?: {
+        journeyId?: string;
+        stageKey?: string;
+    }): ActionBuilder;
     /**
      * CreateCollectionAmcoReplacementWorkOrderFromWorkOrder
      *

package/dist/records-v2/WorkOrderRecord.js

@@ -7877,6 +7877,43 @@ class WorkOrderRecord {
         const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'CompleteServiceWorkOrderFlowSupplier', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'WorkOrderStageDone' }, options);
         return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
     }
+    /**
+     * CreateCollectionAmcoFollowOnWorkOrder
+     *
+     * Updates this WorkOrder record.
+     * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
+     *
+     * @param propertiesOrOptions - Properties to update, or options object
+     * @param options - Optional settings (journeyId, stageKey)
+     * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
+     * @throws Error if called on a new (unsaved) record
+     *
+     * @example
+     * ```typescript
+     * const record = await odinClient.workOrders.get(id);
+     * await record.createCollectionAmcoFollowOnWorkOrder({ ... }).execute();
+     *
+     * // Dry run (for debugging)
+     * const payload = record.createCollectionAmcoFollowOnWorkOrder({ ... }).dryRun();
+     * ```
+     */
+    createCollectionAmcoFollowOnWorkOrder(propertiesOrOptions, options) {
+        var _a;
+        if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
+            throw new Error('createCollectionAmcoFollowOnWorkOrder requires an existing record. Use accessor.get() first.');
+        let properties = {};
+        let opts = options;
+        if (propertiesOrOptions) {
+            if ('journeyId' in propertiesOrOptions || 'stageKey' in propertiesOrOptions) {
+                opts = propertiesOrOptions;
+            }
+            else {
+                properties = propertiesOrOptions;
+            }
+        }
+        const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'CreateCollectionAmcoFollowOnWorkOrder', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, opts);
+        return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
+    }
     /**
      * CreateCollectionAmcoReplacementWorkOrderFromWorkOrder
      *

package/package.json

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