@d19n/youfibre-odin-sdk 2.0.287 → 2.0.288

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -366,7 +366,7 @@ This SDK includes **178** entities across **12** modules.
366
366
 
367
367
  ## Actions
368
368
 
369
- This SDK includes **847** actions.
369
+ This SDK includes **848** actions.
370
370
 
371
371
  ### Action Types
372
372
 
@@ -584,6 +584,7 @@ This SDK includes **847** actions.
584
584
  | `MoveReplacementAmcoToPendingReturn` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToPendingReturn |
585
585
  | `MoveReplacementAmcoToProcessed` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToProcessed |
586
586
  | `MoveReplacementAmcoToReceived` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveReplacementAmcoToReceived |
587
+ | `MoveServiceWorkOrderFromAcceptedToPending` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromAcceptedToPending |
587
588
  | `MoveServiceWorkOrderFromAcceptedToScheduled` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromAcceptedToScheduled |
588
589
  | `MoveServiceWorkOrderFromEnRouteToPending` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromEnRouteToPending |
589
590
  | `MoveServiceWorkOrderFromEnRouteToPendingSupplier` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromEnRouteToPendingSupplier |
@@ -790,6 +791,8 @@ This SDK includes **847** actions.
790
791
 
791
792
  **MoveReplacementAmcoToReceived Target Stages:** `ReplacementAmcoStageReceived`
792
793
 
794
+ **MoveServiceWorkOrderFromAcceptedToPending Target Stages:** `CustomerWorkOrdersStagePending`
795
+
793
796
  **MoveServiceWorkOrderFromAcceptedToScheduled Target Stages:** `WorkOrderStageScheduled`
794
797
 
795
798
  **MoveServiceWorkOrderFromEnRouteToPending Target Stages:** `CustomerWorkOrdersStagePending`
@@ -0,0 +1,70 @@
1
+ /**
2
+ * MoveServiceWorkOrderFromAcceptedToPending Action DTO
3
+ *
4
+ * Move a SERVICE work order from Accepted to Pending so the customer is prompted to book the visit (NET-234 activation-failed START orders).
5
+ *
6
+ * @module FieldServiceModule
7
+ * @entity WorkOrder
8
+ * @entityType SERVICE
9
+ * @actionKey MoveServiceWorkOrderFromAcceptedToPending
10
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromAcceptedToPending
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
15
+ /**
16
+ * RabbitMQ message payload for MoveServiceWorkOrderFromAcceptedToPending step flow events
17
+ *
18
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromAcceptedToPending
19
+ */
20
+ export interface MoveServiceWorkOrderFromAcceptedToPendingMessage extends OdinRecordUpdatedEvent<MoveServiceWorkOrderFromAcceptedToPendingDto, {}> {
21
+ }
22
+ /**
23
+ * Properties for MoveServiceWorkOrderFromAcceptedToPending action
24
+ *
25
+ */
26
+ export interface MoveServiceWorkOrderFromAcceptedToPendingProperties {
27
+ }
28
+ /**
29
+ * Move To Pending
30
+ *
31
+ * Move a SERVICE work order from Accepted to Pending so the customer is prompted to book the visit (NET-234 activation-failed START orders).
32
+ *
33
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
34
+ * @module FieldServiceModule
35
+ * @entity WorkOrder
36
+ * @entityType SERVICE (service)
37
+ * @targetStages CustomerWorkOrdersStagePending
38
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromAcceptedToPending
39
+ * @permission schema.action.moveserviceworkorderfromacceptedtopending.trigger
40
+ * @benchmark This action is tracked for performance benchmarks
41
+ */
42
+ export declare class MoveServiceWorkOrderFromAcceptedToPendingDto extends OdinRecordUpdateDto<Record<string, any>> {
43
+ /** Used by SDK generators to identify action type */
44
+ static readonly ACTION_TYPE = "UPDATE";
45
+ static readonly ACTION_KEY = "MoveServiceWorkOrderFromAcceptedToPending";
46
+ static readonly MODULE_NAME = "FieldServiceModule";
47
+ static readonly ENTITIES: string[];
48
+ static readonly ENTITY_TYPE = "SERVICE";
49
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromAcceptedToPending";
50
+ static readonly SCHEMA_ACTION_ID = "ece23c76-7530-48d8-b452-69f42bc1a89e";
51
+ static readonly PERMISSION = "schema.action.moveserviceworkorderfromacceptedtopending.trigger";
52
+ static readonly TARGET_STAGES: readonly ["CustomerWorkOrdersStagePending"];
53
+ static readonly IS_STAGE_TRANSITION = true;
54
+ static readonly IS_MULTI_STEP_FLOW = false;
55
+ static readonly HAS_STEP_LINKS = false;
56
+ readonly actionName: string;
57
+ readonly schemaActionId: string;
58
+ readonly entity: string;
59
+ readonly stageKey: string;
60
+ constructor(record: OdinRecord<any> | {
61
+ id: string;
62
+ entity: string;
63
+ type?: string;
64
+ }, options?: {
65
+ journeyId?: string;
66
+ });
67
+ /** Step classes that can be used with this action */
68
+ static readonly stepClasses: readonly [];
69
+ steps: [];
70
+ }
@@ -0,0 +1,62 @@
1
+ "use strict";
2
+ /**
3
+ * MoveServiceWorkOrderFromAcceptedToPending Action DTO
4
+ *
5
+ * Move a SERVICE work order from Accepted to Pending so the customer is prompted to book the visit (NET-234 activation-failed START orders).
6
+ *
7
+ * @module FieldServiceModule
8
+ * @entity WorkOrder
9
+ * @entityType SERVICE
10
+ * @actionKey MoveServiceWorkOrderFromAcceptedToPending
11
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromAcceptedToPending
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.MoveServiceWorkOrderFromAcceptedToPendingDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * Move To Pending
20
+ *
21
+ * Move a SERVICE work order from Accepted to Pending so the customer is prompted to book the visit (NET-234 activation-failed START orders).
22
+ *
23
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
24
+ * @module FieldServiceModule
25
+ * @entity WorkOrder
26
+ * @entityType SERVICE (service)
27
+ * @targetStages CustomerWorkOrdersStagePending
28
+ * @event k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromAcceptedToPending
29
+ * @permission schema.action.moveserviceworkorderfromacceptedtopending.trigger
30
+ * @benchmark This action is tracked for performance benchmarks
31
+ */
32
+ class MoveServiceWorkOrderFromAcceptedToPendingDto extends core_1.OdinRecordUpdateDto {
33
+ constructor(record, options) {
34
+ super({
35
+ id: record.id,
36
+ entity: record.entity,
37
+ type: record.type,
38
+ properties: {},
39
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
40
+ });
41
+ this.actionName = 'MoveServiceWorkOrderFromAcceptedToPending';
42
+ this.schemaActionId = 'ece23c76-7530-48d8-b452-69f42bc1a89e';
43
+ this.entity = 'FieldServiceModule:WorkOrder';
44
+ this.stageKey = 'CustomerWorkOrdersStagePending';
45
+ }
46
+ }
47
+ exports.MoveServiceWorkOrderFromAcceptedToPendingDto = MoveServiceWorkOrderFromAcceptedToPendingDto;
48
+ /** Used by SDK generators to identify action type */
49
+ MoveServiceWorkOrderFromAcceptedToPendingDto.ACTION_TYPE = 'UPDATE';
50
+ MoveServiceWorkOrderFromAcceptedToPendingDto.ACTION_KEY = 'MoveServiceWorkOrderFromAcceptedToPending';
51
+ MoveServiceWorkOrderFromAcceptedToPendingDto.MODULE_NAME = 'FieldServiceModule';
52
+ MoveServiceWorkOrderFromAcceptedToPendingDto.ENTITIES = ['WorkOrder'];
53
+ MoveServiceWorkOrderFromAcceptedToPendingDto.ENTITY_TYPE = 'SERVICE';
54
+ MoveServiceWorkOrderFromAcceptedToPendingDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderFromAcceptedToPending';
55
+ MoveServiceWorkOrderFromAcceptedToPendingDto.SCHEMA_ACTION_ID = 'ece23c76-7530-48d8-b452-69f42bc1a89e';
56
+ MoveServiceWorkOrderFromAcceptedToPendingDto.PERMISSION = 'schema.action.moveserviceworkorderfromacceptedtopending.trigger';
57
+ MoveServiceWorkOrderFromAcceptedToPendingDto.TARGET_STAGES = ['CustomerWorkOrdersStagePending'];
58
+ MoveServiceWorkOrderFromAcceptedToPendingDto.IS_STAGE_TRANSITION = true;
59
+ MoveServiceWorkOrderFromAcceptedToPendingDto.IS_MULTI_STEP_FLOW = false;
60
+ MoveServiceWorkOrderFromAcceptedToPendingDto.HAS_STEP_LINKS = false;
61
+ /** Step classes that can be used with this action */
62
+ MoveServiceWorkOrderFromAcceptedToPendingDto.stepClasses = [];
@@ -778,6 +778,7 @@ export declare enum WorkOrderCpe4 {
778
778
  * the reason for the service call (Field Operations - WorkOrder)
779
779
  *
780
780
  * @remarks Available options:
781
+ * - `NO_ACTIVATION_FAILED_ONT_NOT_READY` - [NO] Activation Failed - ONT Not Ready
781
782
  * - `NO_FIBRE_ISSUE_STILL_ACTIVE` - [NO] Fibre Issue Still Active
782
783
  * - `NO_INTERMITTENT_SERVICE` - [NO] Intermittent Service
783
784
  * - `NO_ONT_RELOCATION_CUSTOMER_REQUEST` - [NO] Ont Relocation Customer Request
@@ -792,10 +793,10 @@ export declare enum WorkOrderCpe4 {
792
793
  * - `YF_CANCEL_WO_SPEAK_TO_CUSTOMER` - [YF] Cancel WO Speak To Customer
793
794
  * - `YF_CITY_FIBRE_NEW_INSTALLATION` - [YF] City Fibre New Installation
794
795
  * - `YF_CONNECTION_DROP_OUTS` - [YF] Connection Drop Outs
795
- * - `YF_CPE_DELIVERY` - [YF] CPE Delivery
796
- * - ... and 11 more
796
+ * - ... and 12 more
797
797
  */
798
798
  export declare enum WorkOrderServiceCallReason {
799
+ NO_ACTIVATION_FAILED_ONT_NOT_READY = "NO_ACTIVATION_FAILED_ONT_NOT_READY",
799
800
  NO_FIBRE_ISSUE_STILL_ACTIVE = "NO_FIBRE_ISSUE_STILL_ACTIVE",
800
801
  NO_INTERMITTENT_SERVICE = "NO_INTERMITTENT_SERVICE",
801
802
  NO_ONT_RELOCATION_CUSTOMER_REQUEST = "NO_ONT_RELOCATION_CUSTOMER_REQUEST",
@@ -1319,7 +1320,7 @@ export declare enum WorkOrderReTriggerReason {
1319
1320
  * - `MA_GW` - Mesh add on (Goodwill gesture)
1320
1321
  * - `MSC_ADD` - Misc addition (PSU's / Remotes / cables etc)
1321
1322
  * - `NR_INS` - Non-Received Device at Install
1322
- * - `OO_ND` - Original Order - Non Dispatched (3PL)
1323
+ * - `OO_ND` - Original Order - Non Dispatched
1323
1324
  * - `CP_AV` - Pre installed property - CPE required for activation
1324
1325
  * - ... and 2 more
1325
1326
  */
@@ -1337,7 +1338,7 @@ export declare enum WorkOrderDispatchReason {
1337
1338
  MESH_ADD_ON_GOODWILL_GESTURE = "MA_GW",
1338
1339
  MISC_ADDITION_PSU_S_REMOTES_CABLES_ETC = "MSC_ADD",
1339
1340
  NON_RECEIVED_DEVICE_AT_INSTALL = "NR_INS",
1340
- ORIGINAL_ORDER_NON_DISPATCHED_3_PL = "OO_ND",
1341
+ ORIGINAL_ORDER_NON_DISPATCHED = "OO_ND",
1341
1342
  PRE_INSTALLED_PROPERTY_CPE_REQUIRED_FOR_ACTIVATION = "CP_AV",
1342
1343
  UPGRADE_RENEWAL_CM_REQUEST_FOR_NEW_ROUTER = "UR_CM",
1343
1344
  UPGRADE_RENEWAL_NEW_ROUTER_REQ_FOR_HIGHER_SPEED = "UR_SPD"
@@ -756,6 +756,7 @@ var WorkOrderCpe4;
756
756
  * the reason for the service call (Field Operations - WorkOrder)
757
757
  *
758
758
  * @remarks Available options:
759
+ * - `NO_ACTIVATION_FAILED_ONT_NOT_READY` - [NO] Activation Failed - ONT Not Ready
759
760
  * - `NO_FIBRE_ISSUE_STILL_ACTIVE` - [NO] Fibre Issue Still Active
760
761
  * - `NO_INTERMITTENT_SERVICE` - [NO] Intermittent Service
761
762
  * - `NO_ONT_RELOCATION_CUSTOMER_REQUEST` - [NO] Ont Relocation Customer Request
@@ -770,11 +771,11 @@ var WorkOrderCpe4;
770
771
  * - `YF_CANCEL_WO_SPEAK_TO_CUSTOMER` - [YF] Cancel WO Speak To Customer
771
772
  * - `YF_CITY_FIBRE_NEW_INSTALLATION` - [YF] City Fibre New Installation
772
773
  * - `YF_CONNECTION_DROP_OUTS` - [YF] Connection Drop Outs
773
- * - `YF_CPE_DELIVERY` - [YF] CPE Delivery
774
- * - ... and 11 more
774
+ * - ... and 12 more
775
775
  */
776
776
  var WorkOrderServiceCallReason;
777
777
  (function (WorkOrderServiceCallReason) {
778
+ WorkOrderServiceCallReason["NO_ACTIVATION_FAILED_ONT_NOT_READY"] = "NO_ACTIVATION_FAILED_ONT_NOT_READY";
778
779
  WorkOrderServiceCallReason["NO_FIBRE_ISSUE_STILL_ACTIVE"] = "NO_FIBRE_ISSUE_STILL_ACTIVE";
779
780
  WorkOrderServiceCallReason["NO_INTERMITTENT_SERVICE"] = "NO_INTERMITTENT_SERVICE";
780
781
  WorkOrderServiceCallReason["NO_ONT_RELOCATION_CUSTOMER_REQUEST"] = "NO_ONT_RELOCATION_CUSTOMER_REQUEST";
@@ -1319,7 +1320,7 @@ var WorkOrderReTriggerReason;
1319
1320
  * - `MA_GW` - Mesh add on (Goodwill gesture)
1320
1321
  * - `MSC_ADD` - Misc addition (PSU's / Remotes / cables etc)
1321
1322
  * - `NR_INS` - Non-Received Device at Install
1322
- * - `OO_ND` - Original Order - Non Dispatched (3PL)
1323
+ * - `OO_ND` - Original Order - Non Dispatched
1323
1324
  * - `CP_AV` - Pre installed property - CPE required for activation
1324
1325
  * - ... and 2 more
1325
1326
  */
@@ -1338,7 +1339,7 @@ var WorkOrderDispatchReason;
1338
1339
  WorkOrderDispatchReason["MESH_ADD_ON_GOODWILL_GESTURE"] = "MA_GW";
1339
1340
  WorkOrderDispatchReason["MISC_ADDITION_PSU_S_REMOTES_CABLES_ETC"] = "MSC_ADD";
1340
1341
  WorkOrderDispatchReason["NON_RECEIVED_DEVICE_AT_INSTALL"] = "NR_INS";
1341
- WorkOrderDispatchReason["ORIGINAL_ORDER_NON_DISPATCHED_3_PL"] = "OO_ND";
1342
+ WorkOrderDispatchReason["ORIGINAL_ORDER_NON_DISPATCHED"] = "OO_ND";
1342
1343
  WorkOrderDispatchReason["PRE_INSTALLED_PROPERTY_CPE_REQUIRED_FOR_ACTIVATION"] = "CP_AV";
1343
1344
  WorkOrderDispatchReason["UPGRADE_RENEWAL_CM_REQUEST_FOR_NEW_ROUTER"] = "UR_CM";
1344
1345
  WorkOrderDispatchReason["UPGRADE_RENEWAL_NEW_ROUTER_REQ_FOR_HIGHER_SPEED"] = "UR_SPD";
@@ -7143,6 +7143,31 @@ export declare class WorkOrderRecord<TProps = WorkOrderProperties> {
7143
7143
  moveReplacementAmcoToReceived(options?: {
7144
7144
  journeyId?: string;
7145
7145
  }): ActionBuilder;
7146
+ /**
7147
+ * MoveServiceWorkOrderFromAcceptedToPending
7148
+ *
7149
+ * Transitions this WorkOrder record to a new pipeline stage.
7150
+ * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
7151
+ *
7152
+ * @remarks Transitions to stage: CustomerWorkOrdersStagePending
7153
+ *
7154
+ * @param options - Optional settings
7155
+ * @param options.journeyId - Associate with a journey
7156
+ * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
7157
+ * @throws Error if called on a new (unsaved) record
7158
+ *
7159
+ * @example
7160
+ * ```typescript
7161
+ * const record = await odinClient.workOrders.get(id);
7162
+ * await record.moveServiceWorkOrderFromAcceptedToPending().execute();
7163
+ *
7164
+ * // Dry run (for debugging)
7165
+ * const payload = record.moveServiceWorkOrderFromAcceptedToPending().dryRun();
7166
+ * ```
7167
+ */
7168
+ moveServiceWorkOrderFromAcceptedToPending(options?: {
7169
+ journeyId?: string;
7170
+ }): ActionBuilder;
7146
7171
  /**
7147
7172
  * MoveServiceWorkOrderFromAcceptedToScheduled
7148
7173
  *
@@ -9970,6 +9970,35 @@ class WorkOrderRecord {
9970
9970
  const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MoveReplacementAmcoToReceived', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'ReplacementAmcoStageReceived' }, options);
9971
9971
  return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
9972
9972
  }
9973
+ /**
9974
+ * MoveServiceWorkOrderFromAcceptedToPending
9975
+ *
9976
+ * Transitions this WorkOrder record to a new pipeline stage.
9977
+ * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
9978
+ *
9979
+ * @remarks Transitions to stage: CustomerWorkOrdersStagePending
9980
+ *
9981
+ * @param options - Optional settings
9982
+ * @param options.journeyId - Associate with a journey
9983
+ * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
9984
+ * @throws Error if called on a new (unsaved) record
9985
+ *
9986
+ * @example
9987
+ * ```typescript
9988
+ * const record = await odinClient.workOrders.get(id);
9989
+ * await record.moveServiceWorkOrderFromAcceptedToPending().execute();
9990
+ *
9991
+ * // Dry run (for debugging)
9992
+ * const payload = record.moveServiceWorkOrderFromAcceptedToPending().dryRun();
9993
+ * ```
9994
+ */
9995
+ moveServiceWorkOrderFromAcceptedToPending(options) {
9996
+ var _a;
9997
+ if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
9998
+ throw new Error('moveServiceWorkOrderFromAcceptedToPending requires an existing record. Use accessor.get() first.');
9999
+ const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MoveServiceWorkOrderFromAcceptedToPending', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'CustomerWorkOrdersStagePending' }, options);
10000
+ return new ActionBuilder(this._provider, 'FieldServiceModule', 'WorkOrder', payload, () => { this._pendingLinks = []; });
10001
+ }
9973
10002
  /**
9974
10003
  * MoveServiceWorkOrderFromAcceptedToScheduled
9975
10004
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.287",
3
+ "version": "2.0.288",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",