@d19n/youfibre-odin-sdk 2.0.211 → 2.0.212
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 +10 -1
- package/dist/actions-v2/CancelActiveOrderDto.d.ts +1 -1
- package/dist/actions-v2/CancelOrderForRecontractDto.d.ts +67 -0
- package/dist/actions-v2/CancelOrderForRecontractDto.js +59 -0
- package/dist/actions-v2/CancelOrderForRollbackDto.d.ts +67 -0
- package/dist/actions-v2/CancelOrderForRollbackDto.js +59 -0
- package/dist/actions-v2/CreateChurnRequestDto.d.ts +1 -1
- package/dist/actions-v2/DefaultUpdateChurnRequestDto.d.ts +15 -1
- package/dist/actions-v2/MoveOrderFromDeactivatedToCancelledDto.d.ts +1 -1
- package/dist/actions-v2/MoveOrderFromPendingCancellationToCancelledDto.d.ts +1 -1
- package/dist/actions-v2/MoveOrderFromSupplyToSoldDto.d.ts +67 -0
- package/dist/actions-v2/MoveOrderFromSupplyToSoldDto.js +59 -0
- package/dist/actions-v2/UpdateOrderDto.d.ts +39 -1
- package/dist/entities-v2/Order.d.ts +10 -13
- package/dist/entities-v2/Order.js +3 -5
- package/dist/records-v2/OrderRecord.d.ts +75 -0
- package/dist/records-v2/OrderRecord.js +87 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -357,7 +357,7 @@ This SDK includes **169** entities across **12** modules.
|
|
|
357
357
|
|
|
358
358
|
## Actions
|
|
359
359
|
|
|
360
|
-
This SDK includes **
|
|
360
|
+
This SDK includes **708** actions.
|
|
361
361
|
|
|
362
362
|
### Action Types
|
|
363
363
|
|
|
@@ -376,6 +376,8 @@ This SDK includes **705** actions.
|
|
|
376
376
|
|--------|------|-------|
|
|
377
377
|
| `ActivateOrder` | UPDATE | k1.t-hEOJjsDb.OrderModule.Order.Update.ActivateOrder |
|
|
378
378
|
| `ActivateRecontractOrder` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.ActivateRecontractOrder |
|
|
379
|
+
| `CancelOrderForRecontract` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRecontract |
|
|
380
|
+
| `CancelOrderForRollback` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRollback |
|
|
379
381
|
| `ChangeBillingDay` | UPDATE | k1.t-hEOJjsDb.OrderModule.Order.Update.ChangeBillingDay |
|
|
380
382
|
| `ClearOrderDeactivateOnDate` | UPDATE | k1.t-hEOJjsDb.OrderModule.Order.Update.ClearOrderDeactivateOnDate |
|
|
381
383
|
| `CreateInstallWorkOrderFlow` | UPDATE | k1.t-hEOJjsDb.OrderModule.Order.Flow.CreateInstallWorkOrderFlow |
|
|
@@ -392,6 +394,7 @@ This SDK includes **705** actions.
|
|
|
392
394
|
| `MoveOrderFromDraftToAnyStage` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromDraftToAnyStage |
|
|
393
395
|
| `MoveOrderFromPendingCancellationToActive` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromPendingCancellationToActive |
|
|
394
396
|
| `MoveOrderFromPreOrderToCancelled` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromPreOrderToCancelled |
|
|
397
|
+
| `MoveOrderFromSupplyToSold` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToSold |
|
|
395
398
|
| `MoveOrderToActive` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Update.ActivateOrder |
|
|
396
399
|
| `MoveOrderToDeactivatedFromActive` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderToDeactivatedFromActive |
|
|
397
400
|
| `OderUpdate` | UPDATE | k1.t-hEOJjsDb.OrderModule.Order.Update.OderUpdate |
|
|
@@ -403,6 +406,10 @@ This SDK includes **705** actions.
|
|
|
403
406
|
|
|
404
407
|
**ActivateRecontractOrder Target Stages:** `OrderStageActive`
|
|
405
408
|
|
|
409
|
+
**CancelOrderForRecontract Target Stages:** `OrderStageCancelled`
|
|
410
|
+
|
|
411
|
+
**CancelOrderForRollback Target Stages:** `OrderStageCancelled`
|
|
412
|
+
|
|
406
413
|
**DeactivateOrderDunning Target Stages:** `OrderStageDeactivated`
|
|
407
414
|
|
|
408
415
|
**MoveBrskMigrationRemediationToCancelled Target Stages:** `OrderStageCancelled`
|
|
@@ -425,6 +432,8 @@ This SDK includes **705** actions.
|
|
|
425
432
|
|
|
426
433
|
**MoveOrderFromPreOrderToCancelled Target Stages:** `OrderStageCancelled`
|
|
427
434
|
|
|
435
|
+
**MoveOrderFromSupplyToSold Target Stages:** `OrderStageSold`
|
|
436
|
+
|
|
428
437
|
**MoveOrderToActive Target Stages:** `OrderStageActive`
|
|
429
438
|
|
|
430
439
|
**MoveOrderToDeactivatedFromActive Target Stages:** `OrderStageDeactivated`
|
|
@@ -57,7 +57,7 @@ export interface CreateChurnRequestProperties {
|
|
|
57
57
|
* Customer Relocation Address
|
|
58
58
|
* @type {LOOKUP}
|
|
59
59
|
* @visibleWhen Reason = ["SALES_MOVE_OUT","SALES_MOVE_OUT_IN_AREA"]
|
|
60
|
-
* @requiredWhen CustomerAddressInfoNotProvided = ["false"]
|
|
60
|
+
* @requiredWhen CustomerAddressInfoNotProvided = ["false"] AND = []
|
|
61
61
|
*/
|
|
62
62
|
MovingToAddress?: string | null;
|
|
63
63
|
}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CancelOrderForRecontract Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Cancels the previous order as part of the recontracting process with CONTRACT_RENEWAL reason
|
|
5
|
+
*
|
|
6
|
+
* @module OrderModule
|
|
7
|
+
* @entity Order
|
|
8
|
+
* @actionKey CancelOrderForRecontract
|
|
9
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRecontract
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for CancelOrderForRecontract step flow events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRecontract
|
|
18
|
+
*/
|
|
19
|
+
export interface CancelOrderForRecontractMessage extends OdinRecordUpdatedEvent<CancelOrderForRecontractDto, {}> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for CancelOrderForRecontract action
|
|
23
|
+
*
|
|
24
|
+
*/
|
|
25
|
+
export interface CancelOrderForRecontractProperties {
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* CancelOrderForRecontract
|
|
29
|
+
*
|
|
30
|
+
* Cancels the previous order as part of the recontracting process with CONTRACT_RENEWAL reason
|
|
31
|
+
*
|
|
32
|
+
* @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
|
|
33
|
+
* @module OrderModule
|
|
34
|
+
* @entity Order
|
|
35
|
+
* @targetStages OrderStageCancelled
|
|
36
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRecontract
|
|
37
|
+
* @permission schema.action.cancelorderforrecontract.trigger
|
|
38
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
39
|
+
*/
|
|
40
|
+
export declare class CancelOrderForRecontractDto extends OdinRecordUpdateDto<Record<string, any>> {
|
|
41
|
+
/** Used by SDK generators to identify action type */
|
|
42
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
43
|
+
static readonly ACTION_KEY = "CancelOrderForRecontract";
|
|
44
|
+
static readonly MODULE_NAME = "OrderModule";
|
|
45
|
+
static readonly ENTITIES: string[];
|
|
46
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRecontract";
|
|
47
|
+
static readonly SCHEMA_ACTION_ID = "30415082-6b65-45a7-bfb9-0ef63608e8e2";
|
|
48
|
+
static readonly PERMISSION = "schema.action.cancelorderforrecontract.trigger";
|
|
49
|
+
static readonly TARGET_STAGES: readonly ["OrderStageCancelled"];
|
|
50
|
+
static readonly IS_STAGE_TRANSITION = true;
|
|
51
|
+
static readonly IS_MULTI_STEP_FLOW = false;
|
|
52
|
+
static readonly HAS_STEP_LINKS = false;
|
|
53
|
+
readonly actionName: string;
|
|
54
|
+
readonly schemaActionId: string;
|
|
55
|
+
readonly entity: string;
|
|
56
|
+
readonly stageKey: string;
|
|
57
|
+
constructor(record: OdinRecord<any> | {
|
|
58
|
+
id: string;
|
|
59
|
+
entity: string;
|
|
60
|
+
type?: string;
|
|
61
|
+
}, options?: {
|
|
62
|
+
journeyId?: string;
|
|
63
|
+
});
|
|
64
|
+
/** Step classes that can be used with this action */
|
|
65
|
+
static readonly stepClasses: readonly [];
|
|
66
|
+
steps: [];
|
|
67
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CancelOrderForRecontract Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Cancels the previous order as part of the recontracting process with CONTRACT_RENEWAL reason
|
|
6
|
+
*
|
|
7
|
+
* @module OrderModule
|
|
8
|
+
* @entity Order
|
|
9
|
+
* @actionKey CancelOrderForRecontract
|
|
10
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRecontract
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.CancelOrderForRecontractDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* CancelOrderForRecontract
|
|
19
|
+
*
|
|
20
|
+
* Cancels the previous order as part of the recontracting process with CONTRACT_RENEWAL reason
|
|
21
|
+
*
|
|
22
|
+
* @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
|
|
23
|
+
* @module OrderModule
|
|
24
|
+
* @entity Order
|
|
25
|
+
* @targetStages OrderStageCancelled
|
|
26
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRecontract
|
|
27
|
+
* @permission schema.action.cancelorderforrecontract.trigger
|
|
28
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
29
|
+
*/
|
|
30
|
+
class CancelOrderForRecontractDto extends core_1.OdinRecordUpdateDto {
|
|
31
|
+
constructor(record, options) {
|
|
32
|
+
super({
|
|
33
|
+
id: record.id,
|
|
34
|
+
entity: record.entity,
|
|
35
|
+
type: record.type,
|
|
36
|
+
properties: {},
|
|
37
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'CancelOrderForRecontract';
|
|
40
|
+
this.schemaActionId = '30415082-6b65-45a7-bfb9-0ef63608e8e2';
|
|
41
|
+
this.entity = 'OrderModule:Order';
|
|
42
|
+
this.stageKey = 'OrderStageCancelled';
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
exports.CancelOrderForRecontractDto = CancelOrderForRecontractDto;
|
|
46
|
+
/** Used by SDK generators to identify action type */
|
|
47
|
+
CancelOrderForRecontractDto.ACTION_TYPE = 'UPDATE';
|
|
48
|
+
CancelOrderForRecontractDto.ACTION_KEY = 'CancelOrderForRecontract';
|
|
49
|
+
CancelOrderForRecontractDto.MODULE_NAME = 'OrderModule';
|
|
50
|
+
CancelOrderForRecontractDto.ENTITIES = ['Order'];
|
|
51
|
+
CancelOrderForRecontractDto.EVENT_NAME = 'k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRecontract';
|
|
52
|
+
CancelOrderForRecontractDto.SCHEMA_ACTION_ID = '30415082-6b65-45a7-bfb9-0ef63608e8e2';
|
|
53
|
+
CancelOrderForRecontractDto.PERMISSION = 'schema.action.cancelorderforrecontract.trigger';
|
|
54
|
+
CancelOrderForRecontractDto.TARGET_STAGES = ['OrderStageCancelled'];
|
|
55
|
+
CancelOrderForRecontractDto.IS_STAGE_TRANSITION = true;
|
|
56
|
+
CancelOrderForRecontractDto.IS_MULTI_STEP_FLOW = false;
|
|
57
|
+
CancelOrderForRecontractDto.HAS_STEP_LINKS = false;
|
|
58
|
+
/** Step classes that can be used with this action */
|
|
59
|
+
CancelOrderForRecontractDto.stepClasses = [];
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CancelOrderForRollback Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Cancels the new recontracted order during rollback with CONTRACT_RENEWAL_ROLLBACK reason
|
|
5
|
+
*
|
|
6
|
+
* @module OrderModule
|
|
7
|
+
* @entity Order
|
|
8
|
+
* @actionKey CancelOrderForRollback
|
|
9
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRollback
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for CancelOrderForRollback step flow events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRollback
|
|
18
|
+
*/
|
|
19
|
+
export interface CancelOrderForRollbackMessage extends OdinRecordUpdatedEvent<CancelOrderForRollbackDto, {}> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for CancelOrderForRollback action
|
|
23
|
+
*
|
|
24
|
+
*/
|
|
25
|
+
export interface CancelOrderForRollbackProperties {
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* CancelOrderForRollback
|
|
29
|
+
*
|
|
30
|
+
* Cancels the new recontracted order during rollback with CONTRACT_RENEWAL_ROLLBACK reason
|
|
31
|
+
*
|
|
32
|
+
* @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
|
|
33
|
+
* @module OrderModule
|
|
34
|
+
* @entity Order
|
|
35
|
+
* @targetStages OrderStageCancelled
|
|
36
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRollback
|
|
37
|
+
* @permission schema.action.cancelorderforrollback.trigger
|
|
38
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
39
|
+
*/
|
|
40
|
+
export declare class CancelOrderForRollbackDto extends OdinRecordUpdateDto<Record<string, any>> {
|
|
41
|
+
/** Used by SDK generators to identify action type */
|
|
42
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
43
|
+
static readonly ACTION_KEY = "CancelOrderForRollback";
|
|
44
|
+
static readonly MODULE_NAME = "OrderModule";
|
|
45
|
+
static readonly ENTITIES: string[];
|
|
46
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRollback";
|
|
47
|
+
static readonly SCHEMA_ACTION_ID = "6b122c4e-4140-4910-bf66-4994c3a3d046";
|
|
48
|
+
static readonly PERMISSION = "schema.action.cancelorderforrollback.trigger";
|
|
49
|
+
static readonly TARGET_STAGES: readonly ["OrderStageCancelled"];
|
|
50
|
+
static readonly IS_STAGE_TRANSITION = true;
|
|
51
|
+
static readonly IS_MULTI_STEP_FLOW = false;
|
|
52
|
+
static readonly HAS_STEP_LINKS = false;
|
|
53
|
+
readonly actionName: string;
|
|
54
|
+
readonly schemaActionId: string;
|
|
55
|
+
readonly entity: string;
|
|
56
|
+
readonly stageKey: string;
|
|
57
|
+
constructor(record: OdinRecord<any> | {
|
|
58
|
+
id: string;
|
|
59
|
+
entity: string;
|
|
60
|
+
type?: string;
|
|
61
|
+
}, options?: {
|
|
62
|
+
journeyId?: string;
|
|
63
|
+
});
|
|
64
|
+
/** Step classes that can be used with this action */
|
|
65
|
+
static readonly stepClasses: readonly [];
|
|
66
|
+
steps: [];
|
|
67
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CancelOrderForRollback Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Cancels the new recontracted order during rollback with CONTRACT_RENEWAL_ROLLBACK reason
|
|
6
|
+
*
|
|
7
|
+
* @module OrderModule
|
|
8
|
+
* @entity Order
|
|
9
|
+
* @actionKey CancelOrderForRollback
|
|
10
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRollback
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.CancelOrderForRollbackDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* CancelOrderForRollback
|
|
19
|
+
*
|
|
20
|
+
* Cancels the new recontracted order during rollback with CONTRACT_RENEWAL_ROLLBACK reason
|
|
21
|
+
*
|
|
22
|
+
* @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
|
|
23
|
+
* @module OrderModule
|
|
24
|
+
* @entity Order
|
|
25
|
+
* @targetStages OrderStageCancelled
|
|
26
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRollback
|
|
27
|
+
* @permission schema.action.cancelorderforrollback.trigger
|
|
28
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
29
|
+
*/
|
|
30
|
+
class CancelOrderForRollbackDto extends core_1.OdinRecordUpdateDto {
|
|
31
|
+
constructor(record, options) {
|
|
32
|
+
super({
|
|
33
|
+
id: record.id,
|
|
34
|
+
entity: record.entity,
|
|
35
|
+
type: record.type,
|
|
36
|
+
properties: {},
|
|
37
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'CancelOrderForRollback';
|
|
40
|
+
this.schemaActionId = '6b122c4e-4140-4910-bf66-4994c3a3d046';
|
|
41
|
+
this.entity = 'OrderModule:Order';
|
|
42
|
+
this.stageKey = 'OrderStageCancelled';
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
exports.CancelOrderForRollbackDto = CancelOrderForRollbackDto;
|
|
46
|
+
/** Used by SDK generators to identify action type */
|
|
47
|
+
CancelOrderForRollbackDto.ACTION_TYPE = 'UPDATE';
|
|
48
|
+
CancelOrderForRollbackDto.ACTION_KEY = 'CancelOrderForRollback';
|
|
49
|
+
CancelOrderForRollbackDto.MODULE_NAME = 'OrderModule';
|
|
50
|
+
CancelOrderForRollbackDto.ENTITIES = ['Order'];
|
|
51
|
+
CancelOrderForRollbackDto.EVENT_NAME = 'k1.t-hEOJjsDb.OrderModule.Order.Transition.CancelOrderForRollback';
|
|
52
|
+
CancelOrderForRollbackDto.SCHEMA_ACTION_ID = '6b122c4e-4140-4910-bf66-4994c3a3d046';
|
|
53
|
+
CancelOrderForRollbackDto.PERMISSION = 'schema.action.cancelorderforrollback.trigger';
|
|
54
|
+
CancelOrderForRollbackDto.TARGET_STAGES = ['OrderStageCancelled'];
|
|
55
|
+
CancelOrderForRollbackDto.IS_STAGE_TRANSITION = true;
|
|
56
|
+
CancelOrderForRollbackDto.IS_MULTI_STEP_FLOW = false;
|
|
57
|
+
CancelOrderForRollbackDto.HAS_STEP_LINKS = false;
|
|
58
|
+
/** Step classes that can be used with this action */
|
|
59
|
+
CancelOrderForRollbackDto.stepClasses = [];
|
|
@@ -65,7 +65,7 @@ export interface CreateChurnRequestProperties {
|
|
|
65
65
|
* Customer Relocation Address
|
|
66
66
|
* @type {LOOKUP}
|
|
67
67
|
* @visibleWhen Reason = ["SALES_MOVE_OUT","SALES_MOVE_OUT_IN_AREA"]
|
|
68
|
-
* @requiredWhen CustomerAddressInfoNotProvided = ["false"]
|
|
68
|
+
* @requiredWhen CustomerAddressInfoNotProvided = ["false"] AND = []
|
|
69
69
|
*/
|
|
70
70
|
MovingToAddress?: string | null;
|
|
71
71
|
}
|
|
@@ -22,7 +22,7 @@ export interface DefaultUpdateChurnRequestMessage extends OdinRecordUpdatedEvent
|
|
|
22
22
|
* Properties for DefaultUpdateChurnRequest action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 1
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 3
|
|
26
26
|
*/
|
|
27
27
|
export interface DefaultUpdateChurnRequestProperties {
|
|
28
28
|
/**
|
|
@@ -33,6 +33,20 @@ export interface DefaultUpdateChurnRequestProperties {
|
|
|
33
33
|
* @required
|
|
34
34
|
*/
|
|
35
35
|
Reason: string;
|
|
36
|
+
/**
|
|
37
|
+
* Gaining Provider
|
|
38
|
+
*
|
|
39
|
+
* Gaining Provider
|
|
40
|
+
* @type {ENUM}
|
|
41
|
+
*/
|
|
42
|
+
GainingProvider?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* Outcome
|
|
45
|
+
*
|
|
46
|
+
* Data field for ChurnRequest records. Used by Sales team.
|
|
47
|
+
* @type {ENUM}
|
|
48
|
+
*/
|
|
49
|
+
Outcome?: string | null;
|
|
36
50
|
/**
|
|
37
51
|
* Comment
|
|
38
52
|
*
|
|
@@ -57,7 +57,7 @@ export interface CreateChurnRequestProperties {
|
|
|
57
57
|
* Customer Relocation Address
|
|
58
58
|
* @type {LOOKUP}
|
|
59
59
|
* @visibleWhen Reason = ["SALES_MOVE_OUT","SALES_MOVE_OUT_IN_AREA"]
|
|
60
|
-
* @requiredWhen CustomerAddressInfoNotProvided = ["false"]
|
|
60
|
+
* @requiredWhen CustomerAddressInfoNotProvided = ["false"] AND = []
|
|
61
61
|
*/
|
|
62
62
|
MovingToAddress?: string | null;
|
|
63
63
|
}
|
|
@@ -57,7 +57,7 @@ export interface CreateChurnRequestProperties {
|
|
|
57
57
|
* Customer Relocation Address
|
|
58
58
|
* @type {LOOKUP}
|
|
59
59
|
* @visibleWhen Reason = ["SALES_MOVE_OUT","SALES_MOVE_OUT_IN_AREA"]
|
|
60
|
-
* @requiredWhen CustomerAddressInfoNotProvided = ["false"]
|
|
60
|
+
* @requiredWhen CustomerAddressInfoNotProvided = ["false"] AND = []
|
|
61
61
|
*/
|
|
62
62
|
MovingToAddress?: string | null;
|
|
63
63
|
}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* MoveOrderFromSupplyToSold Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Move order from supply to sold
|
|
5
|
+
*
|
|
6
|
+
* @module OrderModule
|
|
7
|
+
* @entity Order
|
|
8
|
+
* @actionKey MoveOrderFromSupplyToSold
|
|
9
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToSold
|
|
10
|
+
*
|
|
11
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
12
|
+
*/
|
|
13
|
+
import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
|
|
14
|
+
/**
|
|
15
|
+
* RabbitMQ message payload for MoveOrderFromSupplyToSold step flow events
|
|
16
|
+
*
|
|
17
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToSold
|
|
18
|
+
*/
|
|
19
|
+
export interface MoveOrderFromSupplyToSoldMessage extends OdinRecordUpdatedEvent<MoveOrderFromSupplyToSoldDto, {}> {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Properties for MoveOrderFromSupplyToSold action
|
|
23
|
+
*
|
|
24
|
+
*/
|
|
25
|
+
export interface MoveOrderFromSupplyToSoldProperties {
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* MoveOrderFromSupplyToSold
|
|
29
|
+
*
|
|
30
|
+
* Move order from supply to sold
|
|
31
|
+
*
|
|
32
|
+
* @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
|
|
33
|
+
* @module OrderModule
|
|
34
|
+
* @entity Order
|
|
35
|
+
* @targetStages OrderStageSold
|
|
36
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToSold
|
|
37
|
+
* @permission schema.action.moveorderfromsupplytosold.trigger
|
|
38
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
39
|
+
*/
|
|
40
|
+
export declare class MoveOrderFromSupplyToSoldDto extends OdinRecordUpdateDto<Record<string, any>> {
|
|
41
|
+
/** Used by SDK generators to identify action type */
|
|
42
|
+
static readonly ACTION_TYPE = "UPDATE";
|
|
43
|
+
static readonly ACTION_KEY = "MoveOrderFromSupplyToSold";
|
|
44
|
+
static readonly MODULE_NAME = "OrderModule";
|
|
45
|
+
static readonly ENTITIES: string[];
|
|
46
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToSold";
|
|
47
|
+
static readonly SCHEMA_ACTION_ID = "6ca75a74-4363-42b8-81db-2111a3cf050a";
|
|
48
|
+
static readonly PERMISSION = "schema.action.moveorderfromsupplytosold.trigger";
|
|
49
|
+
static readonly TARGET_STAGES: readonly ["OrderStageSold"];
|
|
50
|
+
static readonly IS_STAGE_TRANSITION = true;
|
|
51
|
+
static readonly IS_MULTI_STEP_FLOW = false;
|
|
52
|
+
static readonly HAS_STEP_LINKS = false;
|
|
53
|
+
readonly actionName: string;
|
|
54
|
+
readonly schemaActionId: string;
|
|
55
|
+
readonly entity: string;
|
|
56
|
+
readonly stageKey: string;
|
|
57
|
+
constructor(record: OdinRecord<any> | {
|
|
58
|
+
id: string;
|
|
59
|
+
entity: string;
|
|
60
|
+
type?: string;
|
|
61
|
+
}, options?: {
|
|
62
|
+
journeyId?: string;
|
|
63
|
+
});
|
|
64
|
+
/** Step classes that can be used with this action */
|
|
65
|
+
static readonly stepClasses: readonly [];
|
|
66
|
+
steps: [];
|
|
67
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* MoveOrderFromSupplyToSold Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Move order from supply to sold
|
|
6
|
+
*
|
|
7
|
+
* @module OrderModule
|
|
8
|
+
* @entity Order
|
|
9
|
+
* @actionKey MoveOrderFromSupplyToSold
|
|
10
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToSold
|
|
11
|
+
*
|
|
12
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
13
|
+
*/
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.MoveOrderFromSupplyToSoldDto = void 0;
|
|
16
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
|
+
/**
|
|
18
|
+
* MoveOrderFromSupplyToSold
|
|
19
|
+
*
|
|
20
|
+
* Move order from supply to sold
|
|
21
|
+
*
|
|
22
|
+
* @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
|
|
23
|
+
* @module OrderModule
|
|
24
|
+
* @entity Order
|
|
25
|
+
* @targetStages OrderStageSold
|
|
26
|
+
* @event k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToSold
|
|
27
|
+
* @permission schema.action.moveorderfromsupplytosold.trigger
|
|
28
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
29
|
+
*/
|
|
30
|
+
class MoveOrderFromSupplyToSoldDto extends core_1.OdinRecordUpdateDto {
|
|
31
|
+
constructor(record, options) {
|
|
32
|
+
super({
|
|
33
|
+
id: record.id,
|
|
34
|
+
entity: record.entity,
|
|
35
|
+
type: record.type,
|
|
36
|
+
properties: {},
|
|
37
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'MoveOrderFromSupplyToSold';
|
|
40
|
+
this.schemaActionId = '6ca75a74-4363-42b8-81db-2111a3cf050a';
|
|
41
|
+
this.entity = 'OrderModule:Order';
|
|
42
|
+
this.stageKey = 'OrderStageSold';
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
exports.MoveOrderFromSupplyToSoldDto = MoveOrderFromSupplyToSoldDto;
|
|
46
|
+
/** Used by SDK generators to identify action type */
|
|
47
|
+
MoveOrderFromSupplyToSoldDto.ACTION_TYPE = 'UPDATE';
|
|
48
|
+
MoveOrderFromSupplyToSoldDto.ACTION_KEY = 'MoveOrderFromSupplyToSold';
|
|
49
|
+
MoveOrderFromSupplyToSoldDto.MODULE_NAME = 'OrderModule';
|
|
50
|
+
MoveOrderFromSupplyToSoldDto.ENTITIES = ['Order'];
|
|
51
|
+
MoveOrderFromSupplyToSoldDto.EVENT_NAME = 'k1.t-hEOJjsDb.OrderModule.Order.Transition.MoveOrderFromSupplyToSold';
|
|
52
|
+
MoveOrderFromSupplyToSoldDto.SCHEMA_ACTION_ID = '6ca75a74-4363-42b8-81db-2111a3cf050a';
|
|
53
|
+
MoveOrderFromSupplyToSoldDto.PERMISSION = 'schema.action.moveorderfromsupplytosold.trigger';
|
|
54
|
+
MoveOrderFromSupplyToSoldDto.TARGET_STAGES = ['OrderStageSold'];
|
|
55
|
+
MoveOrderFromSupplyToSoldDto.IS_STAGE_TRANSITION = true;
|
|
56
|
+
MoveOrderFromSupplyToSoldDto.IS_MULTI_STEP_FLOW = false;
|
|
57
|
+
MoveOrderFromSupplyToSoldDto.HAS_STEP_LINKS = false;
|
|
58
|
+
/** Step classes that can be used with this action */
|
|
59
|
+
MoveOrderFromSupplyToSoldDto.stepClasses = [];
|
|
@@ -22,7 +22,7 @@ export interface UpdateOrderMessage extends OdinRecordUpdatedEvent<UpdateOrderDt
|
|
|
22
22
|
* Properties for UpdateOrder action
|
|
23
23
|
*
|
|
24
24
|
* @property Required fields: 0
|
|
25
|
-
* @property Optional fields:
|
|
25
|
+
* @property Optional fields: 8
|
|
26
26
|
*/
|
|
27
27
|
export interface UpdateOrderProperties {
|
|
28
28
|
/**
|
|
@@ -46,6 +46,44 @@ export interface UpdateOrderProperties {
|
|
|
46
46
|
* @type {TEXT}
|
|
47
47
|
*/
|
|
48
48
|
ExternalRefBrskFNO?: string | null;
|
|
49
|
+
/**
|
|
50
|
+
* alert message
|
|
51
|
+
*
|
|
52
|
+
* alerts that need to be visible on the order (Sales - Order)
|
|
53
|
+
* @type {TEXT_LONG}
|
|
54
|
+
*/
|
|
55
|
+
AlertMessage?: string | null;
|
|
56
|
+
/**
|
|
57
|
+
* alert message date
|
|
58
|
+
*
|
|
59
|
+
* the date of the alert message (Sales - Order)
|
|
60
|
+
* @type {DATE}
|
|
61
|
+
* @format DD/MM/YYYY
|
|
62
|
+
*/
|
|
63
|
+
AlertMessageDate?: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* active date
|
|
66
|
+
*
|
|
67
|
+
* active date (Sales - Order)
|
|
68
|
+
* @type {DATE}
|
|
69
|
+
* @format DD/MM/YYYY
|
|
70
|
+
*/
|
|
71
|
+
ActiveDate?: string | null;
|
|
72
|
+
/**
|
|
73
|
+
* billing start date
|
|
74
|
+
*
|
|
75
|
+
* Billing start date (Sales - Order)
|
|
76
|
+
* @type {DATE}
|
|
77
|
+
* @format DD/MM/YYYY
|
|
78
|
+
*/
|
|
79
|
+
BillingStartDate?: string | null;
|
|
80
|
+
/**
|
|
81
|
+
* billing day
|
|
82
|
+
*
|
|
83
|
+
* Billing day in the month (Sales - Order)
|
|
84
|
+
* @type {NUMBER}
|
|
85
|
+
*/
|
|
86
|
+
BillingDay?: number | null;
|
|
49
87
|
}
|
|
50
88
|
/**
|
|
51
89
|
* UpdateOrder
|
|
@@ -244,7 +244,6 @@ export declare enum OrderBillingTerms {
|
|
|
244
244
|
* - `NETOMNIA_LEGACY` - Netomnia legacy
|
|
245
245
|
* - `OPENREACH` - Openreach
|
|
246
246
|
* - `PYOMNI` - PyOmni
|
|
247
|
-
* - `VMO2`
|
|
248
247
|
*/
|
|
249
248
|
export declare enum OrderProvider {
|
|
250
249
|
BRSK = "BRSK",
|
|
@@ -252,8 +251,7 @@ export declare enum OrderProvider {
|
|
|
252
251
|
NETOMNIA = "NETOMNIA",
|
|
253
252
|
NETOMNIA_LEGACY = "NETOMNIA_LEGACY",
|
|
254
253
|
OPENREACH = "OPENREACH",
|
|
255
|
-
PY_OMNI = "PYOMNI"
|
|
256
|
-
VMO2 = "VMO2"
|
|
254
|
+
PY_OMNI = "PYOMNI"
|
|
257
255
|
}
|
|
258
256
|
/**
|
|
259
257
|
* Valid values for Order.ActivationStatus
|
|
@@ -467,10 +465,10 @@ export declare enum OrderPropertyKeys {
|
|
|
467
465
|
CashbackApprovalDate = "CashbackApprovalDate",
|
|
468
466
|
/** Supplier-committed fulfillment date carried on COMMITTED KCI (per yf-kci-effect-bridge.ts#provide-committed). Stamped onto YF Order via walker-driven receiveKci PROPERTY_WRITE. */
|
|
469
467
|
CommittedDate = "CommittedDate",
|
|
470
|
-
/**
|
|
471
|
-
ExternalReferenceOts = "ExternalReferenceOts",
|
|
472
|
-
/** Brsk OTS Data (Legacy) */
|
|
468
|
+
/** LegacyBrskOtsData */
|
|
473
469
|
LegacyBrskOtsData = "LegacyBrskOtsData",
|
|
470
|
+
/** One Touch Switch reference number */
|
|
471
|
+
ExternalReferenceOts = "ExternalReferenceOts",
|
|
474
472
|
/** status of the order (must be activated for billing) (Sales - Order) */
|
|
475
473
|
ActivationStatus = "ActivationStatus"
|
|
476
474
|
}
|
|
@@ -1045,19 +1043,18 @@ export interface OrderProperties {
|
|
|
1045
1043
|
/** Supplier-committed fulfillment date carried on COMMITTED KCI (per yf-kci-effect-bridge.ts#provide-committed). Stamped onto YF Order via walker-driven receiveKci PROPERTY_WRITE.
|
|
1046
1044
|
*
|
|
1047
1045
|
* @type {DATE}
|
|
1048
|
-
* @tracked Changes to this field are tracked in audit history
|
|
1049
1046
|
*/
|
|
1050
1047
|
CommittedDate: string;
|
|
1051
|
-
/**
|
|
1052
|
-
*
|
|
1053
|
-
* @type {TEXT}
|
|
1054
|
-
*/
|
|
1055
|
-
ExternalReferenceOts: string;
|
|
1056
|
-
/** Brsk OTS Data (Legacy)
|
|
1048
|
+
/** LegacyBrskOtsData
|
|
1057
1049
|
*
|
|
1058
1050
|
* @type {JSON}
|
|
1059
1051
|
*/
|
|
1060
1052
|
LegacyBrskOtsData: string;
|
|
1053
|
+
/** One Touch Switch reference number
|
|
1054
|
+
*
|
|
1055
|
+
* @type {TEXT}
|
|
1056
|
+
*/
|
|
1057
|
+
ExternalReferenceOts: string;
|
|
1061
1058
|
/** status of the order (must be activated for billing) (Sales - Order)
|
|
1062
1059
|
*
|
|
1063
1060
|
* @type {ENUM}
|
|
@@ -223,7 +223,6 @@ var OrderBillingTerms;
|
|
|
223
223
|
* - `NETOMNIA_LEGACY` - Netomnia legacy
|
|
224
224
|
* - `OPENREACH` - Openreach
|
|
225
225
|
* - `PYOMNI` - PyOmni
|
|
226
|
-
* - `VMO2`
|
|
227
226
|
*/
|
|
228
227
|
var OrderProvider;
|
|
229
228
|
(function (OrderProvider) {
|
|
@@ -233,7 +232,6 @@ var OrderProvider;
|
|
|
233
232
|
OrderProvider["NETOMNIA_LEGACY"] = "NETOMNIA_LEGACY";
|
|
234
233
|
OrderProvider["OPENREACH"] = "OPENREACH";
|
|
235
234
|
OrderProvider["PY_OMNI"] = "PYOMNI";
|
|
236
|
-
OrderProvider["VMO2"] = "VMO2";
|
|
237
235
|
})(OrderProvider = exports.OrderProvider || (exports.OrderProvider = {}));
|
|
238
236
|
/**
|
|
239
237
|
* Valid values for Order.ActivationStatus
|
|
@@ -449,10 +447,10 @@ var OrderPropertyKeys;
|
|
|
449
447
|
OrderPropertyKeys["CashbackApprovalDate"] = "CashbackApprovalDate";
|
|
450
448
|
/** Supplier-committed fulfillment date carried on COMMITTED KCI (per yf-kci-effect-bridge.ts#provide-committed). Stamped onto YF Order via walker-driven receiveKci PROPERTY_WRITE. */
|
|
451
449
|
OrderPropertyKeys["CommittedDate"] = "CommittedDate";
|
|
452
|
-
/**
|
|
453
|
-
OrderPropertyKeys["ExternalReferenceOts"] = "ExternalReferenceOts";
|
|
454
|
-
/** Brsk OTS Data (Legacy) */
|
|
450
|
+
/** LegacyBrskOtsData */
|
|
455
451
|
OrderPropertyKeys["LegacyBrskOtsData"] = "LegacyBrskOtsData";
|
|
452
|
+
/** One Touch Switch reference number */
|
|
453
|
+
OrderPropertyKeys["ExternalReferenceOts"] = "ExternalReferenceOts";
|
|
456
454
|
/** status of the order (must be activated for billing) (Sales - Order) */
|
|
457
455
|
OrderPropertyKeys["ActivationStatus"] = "ActivationStatus";
|
|
458
456
|
})(OrderPropertyKeys = exports.OrderPropertyKeys || (exports.OrderPropertyKeys = {}));
|
|
@@ -1430,6 +1430,56 @@ export declare class OrderRecord<TProps = OrderProperties> {
|
|
|
1430
1430
|
cancelActiveOrder(options?: {
|
|
1431
1431
|
journeyId?: string;
|
|
1432
1432
|
}): CancelActiveOrderFlowBuilder;
|
|
1433
|
+
/**
|
|
1434
|
+
* CancelOrderForRecontract
|
|
1435
|
+
*
|
|
1436
|
+
* Transitions this Order record to a new pipeline stage.
|
|
1437
|
+
* Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
|
|
1438
|
+
*
|
|
1439
|
+
* @remarks Transitions to stage: OrderStageCancelled
|
|
1440
|
+
*
|
|
1441
|
+
* @param options - Optional settings
|
|
1442
|
+
* @param options.journeyId - Associate with a journey
|
|
1443
|
+
* @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
|
|
1444
|
+
* @throws Error if called on a new (unsaved) record
|
|
1445
|
+
*
|
|
1446
|
+
* @example
|
|
1447
|
+
* ```typescript
|
|
1448
|
+
* const record = await odinClient.orders.get(id);
|
|
1449
|
+
* await record.cancelOrderForRecontract().execute();
|
|
1450
|
+
*
|
|
1451
|
+
* // Dry run (for debugging)
|
|
1452
|
+
* const payload = record.cancelOrderForRecontract().dryRun();
|
|
1453
|
+
* ```
|
|
1454
|
+
*/
|
|
1455
|
+
cancelOrderForRecontract(options?: {
|
|
1456
|
+
journeyId?: string;
|
|
1457
|
+
}): ActionBuilder;
|
|
1458
|
+
/**
|
|
1459
|
+
* CancelOrderForRollback
|
|
1460
|
+
*
|
|
1461
|
+
* Transitions this Order record to a new pipeline stage.
|
|
1462
|
+
* Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
|
|
1463
|
+
*
|
|
1464
|
+
* @remarks Transitions to stage: OrderStageCancelled
|
|
1465
|
+
*
|
|
1466
|
+
* @param options - Optional settings
|
|
1467
|
+
* @param options.journeyId - Associate with a journey
|
|
1468
|
+
* @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
|
|
1469
|
+
* @throws Error if called on a new (unsaved) record
|
|
1470
|
+
*
|
|
1471
|
+
* @example
|
|
1472
|
+
* ```typescript
|
|
1473
|
+
* const record = await odinClient.orders.get(id);
|
|
1474
|
+
* await record.cancelOrderForRollback().execute();
|
|
1475
|
+
*
|
|
1476
|
+
* // Dry run (for debugging)
|
|
1477
|
+
* const payload = record.cancelOrderForRollback().dryRun();
|
|
1478
|
+
* ```
|
|
1479
|
+
*/
|
|
1480
|
+
cancelOrderForRollback(options?: {
|
|
1481
|
+
journeyId?: string;
|
|
1482
|
+
}): ActionBuilder;
|
|
1433
1483
|
/**
|
|
1434
1484
|
* CancelOrderPreInstall
|
|
1435
1485
|
*
|
|
@@ -1949,6 +1999,31 @@ export declare class OrderRecord<TProps = OrderProperties> {
|
|
|
1949
1999
|
moveOrderFromPreOrderToCancelled(options?: {
|
|
1950
2000
|
journeyId?: string;
|
|
1951
2001
|
}): ActionBuilder;
|
|
2002
|
+
/**
|
|
2003
|
+
* MoveOrderFromSupplyToSold
|
|
2004
|
+
*
|
|
2005
|
+
* Transitions this Order record to a new pipeline stage.
|
|
2006
|
+
* Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
|
|
2007
|
+
*
|
|
2008
|
+
* @remarks Transitions to stage: OrderStageSold
|
|
2009
|
+
*
|
|
2010
|
+
* @param options - Optional settings
|
|
2011
|
+
* @param options.journeyId - Associate with a journey
|
|
2012
|
+
* @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
|
|
2013
|
+
* @throws Error if called on a new (unsaved) record
|
|
2014
|
+
*
|
|
2015
|
+
* @example
|
|
2016
|
+
* ```typescript
|
|
2017
|
+
* const record = await odinClient.orders.get(id);
|
|
2018
|
+
* await record.moveOrderFromSupplyToSold().execute();
|
|
2019
|
+
*
|
|
2020
|
+
* // Dry run (for debugging)
|
|
2021
|
+
* const payload = record.moveOrderFromSupplyToSold().dryRun();
|
|
2022
|
+
* ```
|
|
2023
|
+
*/
|
|
2024
|
+
moveOrderFromSupplyToSold(options?: {
|
|
2025
|
+
journeyId?: string;
|
|
2026
|
+
}): ActionBuilder;
|
|
1952
2027
|
/**
|
|
1953
2028
|
* MoveOrderToActive
|
|
1954
2029
|
*
|
|
@@ -2224,6 +2224,64 @@ class OrderRecord {
|
|
|
2224
2224
|
throw new Error('cancelActiveOrder requires an existing record. Use accessor.get() first.');
|
|
2225
2225
|
return new CancelActiveOrderFlowBuilder(this, this._provider, this._pendingLinks, options);
|
|
2226
2226
|
}
|
|
2227
|
+
/**
|
|
2228
|
+
* CancelOrderForRecontract
|
|
2229
|
+
*
|
|
2230
|
+
* Transitions this Order record to a new pipeline stage.
|
|
2231
|
+
* Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
|
|
2232
|
+
*
|
|
2233
|
+
* @remarks Transitions to stage: OrderStageCancelled
|
|
2234
|
+
*
|
|
2235
|
+
* @param options - Optional settings
|
|
2236
|
+
* @param options.journeyId - Associate with a journey
|
|
2237
|
+
* @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
|
|
2238
|
+
* @throws Error if called on a new (unsaved) record
|
|
2239
|
+
*
|
|
2240
|
+
* @example
|
|
2241
|
+
* ```typescript
|
|
2242
|
+
* const record = await odinClient.orders.get(id);
|
|
2243
|
+
* await record.cancelOrderForRecontract().execute();
|
|
2244
|
+
*
|
|
2245
|
+
* // Dry run (for debugging)
|
|
2246
|
+
* const payload = record.cancelOrderForRecontract().dryRun();
|
|
2247
|
+
* ```
|
|
2248
|
+
*/
|
|
2249
|
+
cancelOrderForRecontract(options) {
|
|
2250
|
+
var _a;
|
|
2251
|
+
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
2252
|
+
throw new Error('cancelOrderForRecontract requires an existing record. Use accessor.get() first.');
|
|
2253
|
+
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'CancelOrderForRecontract', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'OrderStageCancelled' }, options);
|
|
2254
|
+
return new ActionBuilder(this._provider, 'OrderModule', 'Order', payload, () => { this._pendingLinks = []; });
|
|
2255
|
+
}
|
|
2256
|
+
/**
|
|
2257
|
+
* CancelOrderForRollback
|
|
2258
|
+
*
|
|
2259
|
+
* Transitions this Order record to a new pipeline stage.
|
|
2260
|
+
* Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
|
|
2261
|
+
*
|
|
2262
|
+
* @remarks Transitions to stage: OrderStageCancelled
|
|
2263
|
+
*
|
|
2264
|
+
* @param options - Optional settings
|
|
2265
|
+
* @param options.journeyId - Associate with a journey
|
|
2266
|
+
* @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
|
|
2267
|
+
* @throws Error if called on a new (unsaved) record
|
|
2268
|
+
*
|
|
2269
|
+
* @example
|
|
2270
|
+
* ```typescript
|
|
2271
|
+
* const record = await odinClient.orders.get(id);
|
|
2272
|
+
* await record.cancelOrderForRollback().execute();
|
|
2273
|
+
*
|
|
2274
|
+
* // Dry run (for debugging)
|
|
2275
|
+
* const payload = record.cancelOrderForRollback().dryRun();
|
|
2276
|
+
* ```
|
|
2277
|
+
*/
|
|
2278
|
+
cancelOrderForRollback(options) {
|
|
2279
|
+
var _a;
|
|
2280
|
+
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
2281
|
+
throw new Error('cancelOrderForRollback requires an existing record. Use accessor.get() first.');
|
|
2282
|
+
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'CancelOrderForRollback', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'OrderStageCancelled' }, options);
|
|
2283
|
+
return new ActionBuilder(this._provider, 'OrderModule', 'Order', payload, () => { this._pendingLinks = []; });
|
|
2284
|
+
}
|
|
2227
2285
|
/**
|
|
2228
2286
|
* CancelOrderPreInstall
|
|
2229
2287
|
*
|
|
@@ -2812,6 +2870,35 @@ class OrderRecord {
|
|
|
2812
2870
|
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);
|
|
2813
2871
|
return new ActionBuilder(this._provider, 'OrderModule', 'Order', payload, () => { this._pendingLinks = []; });
|
|
2814
2872
|
}
|
|
2873
|
+
/**
|
|
2874
|
+
* MoveOrderFromSupplyToSold
|
|
2875
|
+
*
|
|
2876
|
+
* Transitions this Order record to a new pipeline stage.
|
|
2877
|
+
* Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
|
|
2878
|
+
*
|
|
2879
|
+
* @remarks Transitions to stage: OrderStageSold
|
|
2880
|
+
*
|
|
2881
|
+
* @param options - Optional settings
|
|
2882
|
+
* @param options.journeyId - Associate with a journey
|
|
2883
|
+
* @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
|
|
2884
|
+
* @throws Error if called on a new (unsaved) record
|
|
2885
|
+
*
|
|
2886
|
+
* @example
|
|
2887
|
+
* ```typescript
|
|
2888
|
+
* const record = await odinClient.orders.get(id);
|
|
2889
|
+
* await record.moveOrderFromSupplyToSold().execute();
|
|
2890
|
+
*
|
|
2891
|
+
* // Dry run (for debugging)
|
|
2892
|
+
* const payload = record.moveOrderFromSupplyToSold().dryRun();
|
|
2893
|
+
* ```
|
|
2894
|
+
*/
|
|
2895
|
+
moveOrderFromSupplyToSold(options) {
|
|
2896
|
+
var _a;
|
|
2897
|
+
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
2898
|
+
throw new Error('moveOrderFromSupplyToSold requires an existing record. Use accessor.get() first.');
|
|
2899
|
+
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MoveOrderFromSupplyToSold', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'OrderStageSold' }, options);
|
|
2900
|
+
return new ActionBuilder(this._provider, 'OrderModule', 'Order', payload, () => { this._pendingLinks = []; });
|
|
2901
|
+
}
|
|
2815
2902
|
/**
|
|
2816
2903
|
* MoveOrderToActive
|
|
2817
2904
|
*
|