@d19n/youfibre-odin-sdk 2.0.233-beta.2 → 2.0.233-beta.3

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
@@ -184,7 +184,7 @@ This SDK includes **171** entities across **12** modules.
184
184
  |--------|-------------|-------|
185
185
  | **Activity** | Activity Entity Definition | EVENT, NOTIFICATION, TASK |
186
186
  | **Config** | Config Entity Definition | DEFAULT |
187
- | **File** | File Entity Definition | AFP_INVOICE, CSV, EMAIL... |
187
+ | **File** | File Entity Definition | AFP_INVOICE, CBO_FINAL_BILL, CSV... |
188
188
 
189
189
  ### AuditModule
190
190
 
@@ -359,7 +359,7 @@ This SDK includes **171** entities across **12** modules.
359
359
 
360
360
  ## Actions
361
361
 
362
- This SDK includes **742** actions.
362
+ This SDK includes **744** actions.
363
363
 
364
364
  ### Action Types
365
365
 
@@ -1499,8 +1499,14 @@ This SDK includes **742** actions.
1499
1499
  | Action | Type | Event |
1500
1500
  |--------|------|-------|
1501
1501
  | `CreateModifyServiceRequest` | CREATE | k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Create.CreateModifyServiceRequest |
1502
+ | `MoveMsrToComplete` | STAGE_TRANSITION | k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToComplete |
1503
+ | `MoveMsrToFailed` | STAGE_TRANSITION | k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToFailed |
1502
1504
  | `UpdateModifyServiceRequest` | UPDATE | k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Update.UpdateModifyServiceRequest |
1503
1505
 
1506
+ **MoveMsrToComplete Target Stages:** `ModifyServiceRequestStateStageCompleted`
1507
+
1508
+ **MoveMsrToFailed Target Stages:** `ModifyServiceRequestStateStageFailed`
1509
+
1504
1510
  #### NetworkDevice
1505
1511
 
1506
1512
  | Action | Type | Event |
@@ -0,0 +1,115 @@
1
+ /**
2
+ * MoveMsrToComplete Action DTO
3
+ *
4
+ * MoveMsrToComplete
5
+ *
6
+ * @module ServiceModule
7
+ * @entity ModifyServiceRequest
8
+ * @entityType DEFAULT
9
+ * @actionKey MoveMsrToComplete
10
+ * @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToComplete
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
15
+ declare type StepClassMap = {};
16
+ /**
17
+ * Link definition for connecting steps in MoveMsrToComplete
18
+ */
19
+ export interface MoveMsrToCompleteStepLink {
20
+ /**
21
+ * The stepKey of the target step to link TO
22
+ * Must reference another step's stepKey in the same flow
23
+ */
24
+ stepKey: string;
25
+ /**
26
+ * The schema association ID (UUID) defining the relationship
27
+ * Use the association.id from the schema association definition
28
+ * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
29
+ */
30
+ schemaAssociationId: string;
31
+ }
32
+ /**
33
+ * Step definition with linking metadata for MoveMsrToComplete
34
+ */
35
+ export interface MoveMsrToCompleteStepDefinition {
36
+ /** Unique identifier for this step */
37
+ stepKey: string;
38
+ /** The DTO class name for this step */
39
+ dtoClass: string;
40
+ /** The entity this step creates (Module:Entity format) */
41
+ entity: string;
42
+ /** Links to create after this step executes */
43
+ linksTo: MoveMsrToCompleteStepLink[] | null;
44
+ }
45
+ /**
46
+ * Type-safe step keys for MoveMsrToComplete
47
+ */
48
+ export declare const MoveMsrToCompleteSteps: {
49
+ readonly step_1: "step_1";
50
+ };
51
+ export declare type MoveMsrToCompleteStepKey = typeof MoveMsrToCompleteSteps[keyof typeof MoveMsrToCompleteSteps];
52
+ /**
53
+ * RabbitMQ message payload for MoveMsrToComplete step flow events
54
+ *
55
+ * @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToComplete
56
+ */
57
+ export interface MoveMsrToCompleteMessage extends OdinRecordUpdatedEvent<MoveMsrToCompleteDto, {}> {
58
+ }
59
+ /**
60
+ * Properties for MoveMsrToComplete action
61
+ *
62
+ */
63
+ export interface MoveMsrToCompleteProperties {
64
+ }
65
+ /**
66
+ * MoveMsrToComplete
67
+ *
68
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
69
+ * @module ServiceModule
70
+ * @entity ModifyServiceRequest
71
+ * @entityType DEFAULT (Default)
72
+ * @targetStages ModifyServiceRequestStateStageCompleted
73
+ * @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToComplete
74
+ * @permission schema.action.movemsrtocomplete.trigger
75
+ * @benchmark This action is tracked for performance benchmarks
76
+ */
77
+ export declare class MoveMsrToCompleteDto extends OdinRecordUpdateDto<Record<string, any>> {
78
+ /** Used by SDK generators to identify action type */
79
+ static readonly ACTION_TYPE = "UPDATE";
80
+ static readonly ACTION_KEY = "MoveMsrToComplete";
81
+ static readonly MODULE_NAME = "ServiceModule";
82
+ static readonly ENTITIES: string[];
83
+ static readonly ENTITY_TYPE = "DEFAULT";
84
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToComplete";
85
+ static readonly SCHEMA_ACTION_ID = "da6a8b9e-c53f-4e8c-b321-0d506bc99a2a";
86
+ static readonly PERMISSION = "schema.action.movemsrtocomplete.trigger";
87
+ static readonly TARGET_STAGES: readonly ["ModifyServiceRequestStateStageCompleted"];
88
+ static readonly IS_STAGE_TRANSITION = true;
89
+ static readonly IS_MULTI_STEP_FLOW = false;
90
+ static readonly HAS_STEP_LINKS = false;
91
+ /**
92
+ * Step definitions with linking metadata
93
+ * Used by SDK and backend for auto-linking after step execution
94
+ */
95
+ static readonly stepDefinitions: MoveMsrToCompleteStepDefinition[];
96
+ /** Type-safe step key accessor */
97
+ static readonly Steps: {
98
+ readonly step_1: "step_1";
99
+ };
100
+ readonly actionName: string;
101
+ readonly schemaActionId: string;
102
+ readonly entity: string;
103
+ readonly stageKey: string;
104
+ constructor(record: OdinRecord<any> | {
105
+ id: string;
106
+ entity: string;
107
+ type?: string;
108
+ }, options?: {
109
+ journeyId?: string;
110
+ });
111
+ /** Step classes that can be used with this action */
112
+ static readonly stepClasses: readonly [];
113
+ steps: StepClassMap[(typeof MoveMsrToCompleteDto.stepClasses)[number]][];
114
+ }
115
+ export {};
@@ -0,0 +1,80 @@
1
+ "use strict";
2
+ /**
3
+ * MoveMsrToComplete Action DTO
4
+ *
5
+ * MoveMsrToComplete
6
+ *
7
+ * @module ServiceModule
8
+ * @entity ModifyServiceRequest
9
+ * @entityType DEFAULT
10
+ * @actionKey MoveMsrToComplete
11
+ * @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToComplete
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.MoveMsrToCompleteDto = exports.MoveMsrToCompleteSteps = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * Type-safe step keys for MoveMsrToComplete
20
+ */
21
+ exports.MoveMsrToCompleteSteps = {
22
+ step_1: 'step_1',
23
+ };
24
+ /**
25
+ * MoveMsrToComplete
26
+ *
27
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
28
+ * @module ServiceModule
29
+ * @entity ModifyServiceRequest
30
+ * @entityType DEFAULT (Default)
31
+ * @targetStages ModifyServiceRequestStateStageCompleted
32
+ * @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToComplete
33
+ * @permission schema.action.movemsrtocomplete.trigger
34
+ * @benchmark This action is tracked for performance benchmarks
35
+ */
36
+ class MoveMsrToCompleteDto extends core_1.OdinRecordUpdateDto {
37
+ constructor(record, options) {
38
+ super({
39
+ id: record.id,
40
+ entity: record.entity,
41
+ type: record.type,
42
+ properties: {},
43
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
44
+ });
45
+ this.actionName = 'MoveMsrToComplete';
46
+ this.schemaActionId = 'da6a8b9e-c53f-4e8c-b321-0d506bc99a2a';
47
+ this.entity = 'ServiceModule:ModifyServiceRequest';
48
+ this.stageKey = 'ModifyServiceRequestStateStageCompleted';
49
+ }
50
+ }
51
+ exports.MoveMsrToCompleteDto = MoveMsrToCompleteDto;
52
+ /** Used by SDK generators to identify action type */
53
+ MoveMsrToCompleteDto.ACTION_TYPE = 'UPDATE';
54
+ MoveMsrToCompleteDto.ACTION_KEY = 'MoveMsrToComplete';
55
+ MoveMsrToCompleteDto.MODULE_NAME = 'ServiceModule';
56
+ MoveMsrToCompleteDto.ENTITIES = ['ModifyServiceRequest'];
57
+ MoveMsrToCompleteDto.ENTITY_TYPE = 'DEFAULT';
58
+ MoveMsrToCompleteDto.EVENT_NAME = 'k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToComplete';
59
+ MoveMsrToCompleteDto.SCHEMA_ACTION_ID = 'da6a8b9e-c53f-4e8c-b321-0d506bc99a2a';
60
+ MoveMsrToCompleteDto.PERMISSION = 'schema.action.movemsrtocomplete.trigger';
61
+ MoveMsrToCompleteDto.TARGET_STAGES = ['ModifyServiceRequestStateStageCompleted'];
62
+ MoveMsrToCompleteDto.IS_STAGE_TRANSITION = true;
63
+ MoveMsrToCompleteDto.IS_MULTI_STEP_FLOW = false;
64
+ MoveMsrToCompleteDto.HAS_STEP_LINKS = false;
65
+ /**
66
+ * Step definitions with linking metadata
67
+ * Used by SDK and backend for auto-linking after step execution
68
+ */
69
+ MoveMsrToCompleteDto.stepDefinitions = [
70
+ {
71
+ stepKey: 'step_1',
72
+ dtoClass: 'unknown',
73
+ entity: 'unknown',
74
+ linksTo: null
75
+ }
76
+ ];
77
+ /** Type-safe step key accessor */
78
+ MoveMsrToCompleteDto.Steps = exports.MoveMsrToCompleteSteps;
79
+ /** Step classes that can be used with this action */
80
+ MoveMsrToCompleteDto.stepClasses = [];
@@ -0,0 +1,115 @@
1
+ /**
2
+ * MoveMsrToFailed Action DTO
3
+ *
4
+ * MoveMsrToFailed
5
+ *
6
+ * @module ServiceModule
7
+ * @entity ModifyServiceRequest
8
+ * @entityType DEFAULT
9
+ * @actionKey MoveMsrToFailed
10
+ * @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToFailed
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
15
+ declare type StepClassMap = {};
16
+ /**
17
+ * Link definition for connecting steps in MoveMsrToFailed
18
+ */
19
+ export interface MoveMsrToFailedStepLink {
20
+ /**
21
+ * The stepKey of the target step to link TO
22
+ * Must reference another step's stepKey in the same flow
23
+ */
24
+ stepKey: string;
25
+ /**
26
+ * The schema association ID (UUID) defining the relationship
27
+ * Use the association.id from the schema association definition
28
+ * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
29
+ */
30
+ schemaAssociationId: string;
31
+ }
32
+ /**
33
+ * Step definition with linking metadata for MoveMsrToFailed
34
+ */
35
+ export interface MoveMsrToFailedStepDefinition {
36
+ /** Unique identifier for this step */
37
+ stepKey: string;
38
+ /** The DTO class name for this step */
39
+ dtoClass: string;
40
+ /** The entity this step creates (Module:Entity format) */
41
+ entity: string;
42
+ /** Links to create after this step executes */
43
+ linksTo: MoveMsrToFailedStepLink[] | null;
44
+ }
45
+ /**
46
+ * Type-safe step keys for MoveMsrToFailed
47
+ */
48
+ export declare const MoveMsrToFailedSteps: {
49
+ readonly step_1: "step_1";
50
+ };
51
+ export declare type MoveMsrToFailedStepKey = typeof MoveMsrToFailedSteps[keyof typeof MoveMsrToFailedSteps];
52
+ /**
53
+ * RabbitMQ message payload for MoveMsrToFailed step flow events
54
+ *
55
+ * @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToFailed
56
+ */
57
+ export interface MoveMsrToFailedMessage extends OdinRecordUpdatedEvent<MoveMsrToFailedDto, {}> {
58
+ }
59
+ /**
60
+ * Properties for MoveMsrToFailed action
61
+ *
62
+ */
63
+ export interface MoveMsrToFailedProperties {
64
+ }
65
+ /**
66
+ * MoveMsrToFailed
67
+ *
68
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
69
+ * @module ServiceModule
70
+ * @entity ModifyServiceRequest
71
+ * @entityType DEFAULT (Default)
72
+ * @targetStages ModifyServiceRequestStateStageFailed
73
+ * @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToFailed
74
+ * @permission schema.action.movemsrtofailed.trigger
75
+ * @benchmark This action is tracked for performance benchmarks
76
+ */
77
+ export declare class MoveMsrToFailedDto extends OdinRecordUpdateDto<Record<string, any>> {
78
+ /** Used by SDK generators to identify action type */
79
+ static readonly ACTION_TYPE = "UPDATE";
80
+ static readonly ACTION_KEY = "MoveMsrToFailed";
81
+ static readonly MODULE_NAME = "ServiceModule";
82
+ static readonly ENTITIES: string[];
83
+ static readonly ENTITY_TYPE = "DEFAULT";
84
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToFailed";
85
+ static readonly SCHEMA_ACTION_ID = "17a1011e-d474-423a-b392-9edc4b95c839";
86
+ static readonly PERMISSION = "schema.action.movemsrtofailed.trigger";
87
+ static readonly TARGET_STAGES: readonly ["ModifyServiceRequestStateStageFailed"];
88
+ static readonly IS_STAGE_TRANSITION = true;
89
+ static readonly IS_MULTI_STEP_FLOW = false;
90
+ static readonly HAS_STEP_LINKS = false;
91
+ /**
92
+ * Step definitions with linking metadata
93
+ * Used by SDK and backend for auto-linking after step execution
94
+ */
95
+ static readonly stepDefinitions: MoveMsrToFailedStepDefinition[];
96
+ /** Type-safe step key accessor */
97
+ static readonly Steps: {
98
+ readonly step_1: "step_1";
99
+ };
100
+ readonly actionName: string;
101
+ readonly schemaActionId: string;
102
+ readonly entity: string;
103
+ readonly stageKey: string;
104
+ constructor(record: OdinRecord<any> | {
105
+ id: string;
106
+ entity: string;
107
+ type?: string;
108
+ }, options?: {
109
+ journeyId?: string;
110
+ });
111
+ /** Step classes that can be used with this action */
112
+ static readonly stepClasses: readonly [];
113
+ steps: StepClassMap[(typeof MoveMsrToFailedDto.stepClasses)[number]][];
114
+ }
115
+ export {};
@@ -0,0 +1,80 @@
1
+ "use strict";
2
+ /**
3
+ * MoveMsrToFailed Action DTO
4
+ *
5
+ * MoveMsrToFailed
6
+ *
7
+ * @module ServiceModule
8
+ * @entity ModifyServiceRequest
9
+ * @entityType DEFAULT
10
+ * @actionKey MoveMsrToFailed
11
+ * @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToFailed
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.MoveMsrToFailedDto = exports.MoveMsrToFailedSteps = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * Type-safe step keys for MoveMsrToFailed
20
+ */
21
+ exports.MoveMsrToFailedSteps = {
22
+ step_1: 'step_1',
23
+ };
24
+ /**
25
+ * MoveMsrToFailed
26
+ *
27
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
28
+ * @module ServiceModule
29
+ * @entity ModifyServiceRequest
30
+ * @entityType DEFAULT (Default)
31
+ * @targetStages ModifyServiceRequestStateStageFailed
32
+ * @event k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToFailed
33
+ * @permission schema.action.movemsrtofailed.trigger
34
+ * @benchmark This action is tracked for performance benchmarks
35
+ */
36
+ class MoveMsrToFailedDto extends core_1.OdinRecordUpdateDto {
37
+ constructor(record, options) {
38
+ super({
39
+ id: record.id,
40
+ entity: record.entity,
41
+ type: record.type,
42
+ properties: {},
43
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
44
+ });
45
+ this.actionName = 'MoveMsrToFailed';
46
+ this.schemaActionId = '17a1011e-d474-423a-b392-9edc4b95c839';
47
+ this.entity = 'ServiceModule:ModifyServiceRequest';
48
+ this.stageKey = 'ModifyServiceRequestStateStageFailed';
49
+ }
50
+ }
51
+ exports.MoveMsrToFailedDto = MoveMsrToFailedDto;
52
+ /** Used by SDK generators to identify action type */
53
+ MoveMsrToFailedDto.ACTION_TYPE = 'UPDATE';
54
+ MoveMsrToFailedDto.ACTION_KEY = 'MoveMsrToFailed';
55
+ MoveMsrToFailedDto.MODULE_NAME = 'ServiceModule';
56
+ MoveMsrToFailedDto.ENTITIES = ['ModifyServiceRequest'];
57
+ MoveMsrToFailedDto.ENTITY_TYPE = 'DEFAULT';
58
+ MoveMsrToFailedDto.EVENT_NAME = 'k1.t-hEOJjsDb.ServiceModule.ModifyServiceRequest.Transition.MoveMsrToFailed';
59
+ MoveMsrToFailedDto.SCHEMA_ACTION_ID = '17a1011e-d474-423a-b392-9edc4b95c839';
60
+ MoveMsrToFailedDto.PERMISSION = 'schema.action.movemsrtofailed.trigger';
61
+ MoveMsrToFailedDto.TARGET_STAGES = ['ModifyServiceRequestStateStageFailed'];
62
+ MoveMsrToFailedDto.IS_STAGE_TRANSITION = true;
63
+ MoveMsrToFailedDto.IS_MULTI_STEP_FLOW = false;
64
+ MoveMsrToFailedDto.HAS_STEP_LINKS = false;
65
+ /**
66
+ * Step definitions with linking metadata
67
+ * Used by SDK and backend for auto-linking after step execution
68
+ */
69
+ MoveMsrToFailedDto.stepDefinitions = [
70
+ {
71
+ stepKey: 'step_1',
72
+ dtoClass: 'unknown',
73
+ entity: 'unknown',
74
+ linksTo: null
75
+ }
76
+ ];
77
+ /** Type-safe step key accessor */
78
+ MoveMsrToFailedDto.Steps = exports.MoveMsrToFailedSteps;
79
+ /** Step classes that can be used with this action */
80
+ MoveMsrToFailedDto.stepClasses = [];
@@ -78,6 +78,8 @@ import { PgDirectDebitFileProperties } from './PgDirectDebitFile';
78
78
  export declare enum FileEntityTypes {
79
79
  /** application for payment invoice */
80
80
  AFP_INVOICE = "AFP_INVOICE",
81
+ /** Used when customer send their final bill */
82
+ CBO_FINAL_BILL = "CBO_FINAL_BILL",
81
83
  /** CSV */
82
84
  CSV = "CSV",
83
85
  /** This is the default record type */
@@ -290,6 +292,72 @@ export interface AfpInvoiceFileProperties {
290
292
  */
291
293
  MetaData: string;
292
294
  }
295
+ /**
296
+ * Properties for CBO_FINAL_BILL File records
297
+ *
298
+ * @see SchemaModule:File
299
+ */
300
+ export interface CboFinalBillFileProperties {
301
+ /** the storage provider (Platform - File)
302
+ *
303
+ * @type {ENUM}
304
+ * @default AWS_S3
305
+ * @enum {FileDataStore}
306
+ */
307
+ DataStore: FileDataStore;
308
+ /** the full url for the object in an S3 bucket (Platform - File)
309
+ *
310
+ * @type {TEXT}
311
+ * @default
312
+ */
313
+ Url: string;
314
+ /** the object key for aws S3 (Platform - File)
315
+ *
316
+ * @type {TEXT}
317
+ * @default
318
+ */
319
+ Key: string;
320
+ /** the bucket for aws S3 (Platform - File)
321
+ *
322
+ * @type {TEXT}
323
+ * @default
324
+ */
325
+ Bucket: string;
326
+ /** the mimetype for the file (Platform - File)
327
+ *
328
+ * @type {TEXT}
329
+ * @default
330
+ */
331
+ Mimetype: string;
332
+ /** longitude and latitude coordinates (Platform - File)
333
+ *
334
+ * @type {TEXT}
335
+ */
336
+ Coordinates: string;
337
+ /** Image source - type of device (Platform - File)
338
+ *
339
+ * @type {ENUM}
340
+ * @enum {FileDevice}
341
+ * @hidden This field is hidden in the UI
342
+ */
343
+ Device: FileDevice;
344
+ /** the category this file belongs to (Platform - File)
345
+ *
346
+ * @type {ENUM}
347
+ * @enum {FileCategory}
348
+ */
349
+ Category: FileCategory;
350
+ /** the unique hash for the file (Platform - File)
351
+ *
352
+ * @type {TEXT}
353
+ */
354
+ HashId: string;
355
+ /** metadata can store any JSON content (Platform - File)
356
+ *
357
+ * @type {JSON}
358
+ */
359
+ MetaData: string;
360
+ }
293
361
  /**
294
362
  * Properties for CSV File records
295
363
  *
@@ -907,6 +975,12 @@ export declare const ROUTING_KEY_FILE_AFP_INVOICE_CREATED = "SchemaModule.File.A
907
975
  export declare const ROUTING_KEY_FILE_AFP_INVOICE_UPDATED = "SchemaModule.File.AFP_INVOICE.SubDbRecordUpdated";
908
976
  /** application for payment invoice deleted */
909
977
  export declare const ROUTING_KEY_FILE_AFP_INVOICE_DELETED = "SchemaModule.File.AFP_INVOICE.SubDbRecordDeleted";
978
+ /** Used when customer send their final bill created */
979
+ export declare const ROUTING_KEY_FILE_CBO_FINAL_BILL_CREATED = "SchemaModule.File.CBO_FINAL_BILL.SubDbRecordCreated";
980
+ /** Used when customer send their final bill updated */
981
+ export declare const ROUTING_KEY_FILE_CBO_FINAL_BILL_UPDATED = "SchemaModule.File.CBO_FINAL_BILL.SubDbRecordUpdated";
982
+ /** Used when customer send their final bill deleted */
983
+ export declare const ROUTING_KEY_FILE_CBO_FINAL_BILL_DELETED = "SchemaModule.File.CBO_FINAL_BILL.SubDbRecordDeleted";
910
984
  /** CSV created */
911
985
  export declare const ROUTING_KEY_FILE_CSV_CREATED = "SchemaModule.File.CSV.SubDbRecordCreated";
912
986
  /** CSV updated */
@@ -12,7 +12,7 @@
12
12
  * Generated from Odin schema definition
13
13
  */
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.ROUTING_KEY_LINK_FILE_NOTE_DELETED = exports.ROUTING_KEY_LINK_FILE_NOTE_CREATED = exports.ROUTING_KEY_FILE_OTDR_DELETED = exports.ROUTING_KEY_FILE_OTDR_UPDATED = exports.ROUTING_KEY_FILE_OTDR_CREATED = exports.ROUTING_KEY_FILE_OPENREACH_A55_DELETED = exports.ROUTING_KEY_FILE_OPENREACH_A55_UPDATED = exports.ROUTING_KEY_FILE_OPENREACH_A55_CREATED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_DELETED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_UPDATED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_CREATED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_DELETED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_UPDATED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_CREATED = exports.ROUTING_KEY_FILE_INVOICE_DELETED = exports.ROUTING_KEY_FILE_INVOICE_UPDATED = exports.ROUTING_KEY_FILE_INVOICE_CREATED = exports.ROUTING_KEY_FILE_EMAIL_DELETED = exports.ROUTING_KEY_FILE_EMAIL_UPDATED = exports.ROUTING_KEY_FILE_EMAIL_CREATED = exports.ROUTING_KEY_FILE_DEFAULT_DELETED = exports.ROUTING_KEY_FILE_DEFAULT_UPDATED = exports.ROUTING_KEY_FILE_DEFAULT_CREATED = exports.ROUTING_KEY_FILE_CSV_DELETED = exports.ROUTING_KEY_FILE_CSV_UPDATED = exports.ROUTING_KEY_FILE_CSV_CREATED = exports.ROUTING_KEY_FILE_AFP_INVOICE_DELETED = exports.ROUTING_KEY_FILE_AFP_INVOICE_UPDATED = exports.ROUTING_KEY_FILE_AFP_INVOICE_CREATED = exports.ROUTING_KEY_FILE_DELETED = exports.ROUTING_KEY_FILE_UPDATED = exports.ROUTING_KEY_FILE_CREATED = exports.File = exports.FilePropertyKeys = exports.FileCategory = exports.FileDevice = exports.FileDataStore = exports.FileEntityTypes = void 0;
15
+ exports.ROUTING_KEY_LINK_FILE_NOTE_DELETED = exports.ROUTING_KEY_LINK_FILE_NOTE_CREATED = exports.ROUTING_KEY_FILE_OTDR_DELETED = exports.ROUTING_KEY_FILE_OTDR_UPDATED = exports.ROUTING_KEY_FILE_OTDR_CREATED = exports.ROUTING_KEY_FILE_OPENREACH_A55_DELETED = exports.ROUTING_KEY_FILE_OPENREACH_A55_UPDATED = exports.ROUTING_KEY_FILE_OPENREACH_A55_CREATED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_DELETED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_UPDATED = exports.ROUTING_KEY_FILE_NA_SOLUTION_EVIDENCE_CREATED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_DELETED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_UPDATED = exports.ROUTING_KEY_FILE_NA_PROBLEM_EVIDENCE_CREATED = exports.ROUTING_KEY_FILE_INVOICE_DELETED = exports.ROUTING_KEY_FILE_INVOICE_UPDATED = exports.ROUTING_KEY_FILE_INVOICE_CREATED = exports.ROUTING_KEY_FILE_EMAIL_DELETED = exports.ROUTING_KEY_FILE_EMAIL_UPDATED = exports.ROUTING_KEY_FILE_EMAIL_CREATED = exports.ROUTING_KEY_FILE_DEFAULT_DELETED = exports.ROUTING_KEY_FILE_DEFAULT_UPDATED = exports.ROUTING_KEY_FILE_DEFAULT_CREATED = exports.ROUTING_KEY_FILE_CSV_DELETED = exports.ROUTING_KEY_FILE_CSV_UPDATED = exports.ROUTING_KEY_FILE_CSV_CREATED = exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_DELETED = exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_UPDATED = exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_CREATED = exports.ROUTING_KEY_FILE_AFP_INVOICE_DELETED = exports.ROUTING_KEY_FILE_AFP_INVOICE_UPDATED = exports.ROUTING_KEY_FILE_AFP_INVOICE_CREATED = exports.ROUTING_KEY_FILE_DELETED = exports.ROUTING_KEY_FILE_UPDATED = exports.ROUTING_KEY_FILE_CREATED = exports.File = exports.FilePropertyKeys = exports.FileCategory = exports.FileDevice = exports.FileDataStore = exports.FileEntityTypes = void 0;
16
16
  const core_1 = require("@d19n/odin-types/dist/core");
17
17
  /**
18
18
  * Available types for File records
@@ -21,6 +21,8 @@ var FileEntityTypes;
21
21
  (function (FileEntityTypes) {
22
22
  /** application for payment invoice */
23
23
  FileEntityTypes["AFP_INVOICE"] = "AFP_INVOICE";
24
+ /** Used when customer send their final bill */
25
+ FileEntityTypes["CBO_FINAL_BILL"] = "CBO_FINAL_BILL";
24
26
  /** CSV */
25
27
  FileEntityTypes["CSV"] = "CSV";
26
28
  /** This is the default record type */
@@ -138,6 +140,12 @@ exports.ROUTING_KEY_FILE_AFP_INVOICE_CREATED = 'SchemaModule.File.AFP_INVOICE.Su
138
140
  exports.ROUTING_KEY_FILE_AFP_INVOICE_UPDATED = 'SchemaModule.File.AFP_INVOICE.SubDbRecordUpdated';
139
141
  /** application for payment invoice deleted */
140
142
  exports.ROUTING_KEY_FILE_AFP_INVOICE_DELETED = 'SchemaModule.File.AFP_INVOICE.SubDbRecordDeleted';
143
+ /** Used when customer send their final bill created */
144
+ exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_CREATED = 'SchemaModule.File.CBO_FINAL_BILL.SubDbRecordCreated';
145
+ /** Used when customer send their final bill updated */
146
+ exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_UPDATED = 'SchemaModule.File.CBO_FINAL_BILL.SubDbRecordUpdated';
147
+ /** Used when customer send their final bill deleted */
148
+ exports.ROUTING_KEY_FILE_CBO_FINAL_BILL_DELETED = 'SchemaModule.File.CBO_FINAL_BILL.SubDbRecordDeleted';
141
149
  /** CSV created */
142
150
  exports.ROUTING_KEY_FILE_CSV_CREATED = 'SchemaModule.File.CSV.SubDbRecordCreated';
143
151
  /** CSV updated */
@@ -135,7 +135,6 @@ export interface ModifyServiceRequestProperties {
135
135
  /** ISP Modify Status
136
136
  *
137
137
  * @type {ENUM}
138
- * @default NOT_SENT
139
138
  * @enum {ModifyServiceRequestIspModifyStatus}
140
139
  */
141
140
  IspModifyStatus: ModifyServiceRequestIspModifyStatus;
@@ -13,7 +13,7 @@
13
13
  * await record.createFile({ ... }).execute();
14
14
  * ```
15
15
  *
16
- * Entity Types: AFP_INVOICE, CSV, DEFAULT, EMAIL, INVOICE, NA_PROBLEM_EVIDENCE, NA_SOLUTION_EVIDENCE, OPENREACH_A55, OTDR
16
+ * Entity Types: AFP_INVOICE, CBO_FINAL_BILL, CSV, DEFAULT, EMAIL, INVOICE, NA_PROBLEM_EVIDENCE, NA_SOLUTION_EVIDENCE, OPENREACH_A55, OTDR
17
17
  *
18
18
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
19
19
  */
@@ -22,7 +22,7 @@ import { PipelineStageEntity } from '@d19n/odin-types/dist/core';
22
22
  import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/v1.db.interfaces';
23
23
  import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
24
24
  import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
25
- import { FileProperties, AfpInvoiceFileProperties, CsvFileProperties, EmailFileProperties, InvoiceFileProperties, NaProblemEvidenceFileProperties, NaSolutionEvidenceFileProperties, OpenreachA55FileProperties, OtdrFileProperties } from '../entities-v2/File';
25
+ import { FileProperties, AfpInvoiceFileProperties, CboFinalBillFileProperties, CsvFileProperties, EmailFileProperties, InvoiceFileProperties, NaProblemEvidenceFileProperties, NaSolutionEvidenceFileProperties, OpenreachA55FileProperties, OtdrFileProperties } from '../entities-v2/File';
26
26
  import { CreateFileProperties } from '../actions-v2/CreateFileDto';
27
27
  import { OverlayRealA55Record } from './OverlayRealA55Record';
28
28
  import { AppointmentRecord } from './AppointmentRecord';
@@ -64,7 +64,7 @@ import { MessageRecord } from './MessageRecord';
64
64
  import { EmailRecord } from './EmailRecord';
65
65
  import { PgDirectDebitFileRecord } from './PgDirectDebitFileRecord';
66
66
  /** Valid entity types for File */
67
- export declare type FileType = 'AFP_INVOICE' | 'CSV' | 'DEFAULT' | 'EMAIL' | 'INVOICE' | 'NA_PROBLEM_EVIDENCE' | 'NA_SOLUTION_EVIDENCE' | 'OPENREACH_A55' | 'OTDR';
67
+ export declare type FileType = 'AFP_INVOICE' | 'CBO_FINAL_BILL' | 'CSV' | 'DEFAULT' | 'EMAIL' | 'INVOICE' | 'NA_PROBLEM_EVIDENCE' | 'NA_SOLUTION_EVIDENCE' | 'OPENREACH_A55' | 'OTDR';
68
68
  /**
69
69
  * Builder for action execution with dryRun support
70
70
  *
@@ -208,6 +208,22 @@ export declare class FileRecord<TProps = FileProperties> {
208
208
  * @remarks application for payment invoice
209
209
  */
210
210
  isAfpInvoice(): this is FileRecord<AfpInvoiceFileProperties>;
211
+ /**
212
+ * Type guard: check if this record is of type CBO_FINAL_BILL
213
+ *
214
+ * When this returns true, TypeScript automatically narrows the type,
215
+ * giving you access to CBO_FINAL_BILL-specific properties.
216
+ *
217
+ * @example
218
+ * ```typescript
219
+ * if (record.isCboFinalBill()) {
220
+ * // TypeScript knows record.properties is CboFinalBillFileProperties
221
+ * console.log(record.properties.SomeTypeSpecificField);
222
+ * }
223
+ * ```
224
+ * @remarks Used when customer send their final bill
225
+ */
226
+ isCboFinalBill(): this is FileRecord<CboFinalBillFileProperties>;
211
227
  /**
212
228
  * Type guard: check if this record is of type CSV
213
229
  *
@@ -14,7 +14,7 @@
14
14
  * await record.createFile({ ... }).execute();
15
15
  * ```
16
16
  *
17
- * Entity Types: AFP_INVOICE, CSV, DEFAULT, EMAIL, INVOICE, NA_PROBLEM_EVIDENCE, NA_SOLUTION_EVIDENCE, OPENREACH_A55, OTDR
17
+ * Entity Types: AFP_INVOICE, CBO_FINAL_BILL, CSV, DEFAULT, EMAIL, INVOICE, NA_PROBLEM_EVIDENCE, NA_SOLUTION_EVIDENCE, OPENREACH_A55, OTDR
18
18
  *
19
19
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
20
20
  */
@@ -200,6 +200,22 @@ class FileRecord {
200
200
  * @remarks application for payment invoice
201
201
  */
202
202
  isAfpInvoice() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'AFP_INVOICE'; }
203
+ /**
204
+ * Type guard: check if this record is of type CBO_FINAL_BILL
205
+ *
206
+ * When this returns true, TypeScript automatically narrows the type,
207
+ * giving you access to CBO_FINAL_BILL-specific properties.
208
+ *
209
+ * @example
210
+ * ```typescript
211
+ * if (record.isCboFinalBill()) {
212
+ * // TypeScript knows record.properties is CboFinalBillFileProperties
213
+ * console.log(record.properties.SomeTypeSpecificField);
214
+ * }
215
+ * ```
216
+ * @remarks Used when customer send their final bill
217
+ */
218
+ isCboFinalBill() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'CBO_FINAL_BILL'; }
203
219
  /**
204
220
  * Type guard: check if this record is of type CSV
205
221
  *
@@ -220,6 +220,56 @@ export declare class ModifyServiceRequestRecord<TProps = ModifyServiceRequestPro
220
220
  journeyId?: string;
221
221
  stageKey?: string;
222
222
  }): ActionBuilder;
223
+ /**
224
+ * MoveMsrToComplete
225
+ *
226
+ * Transitions this ModifyServiceRequest record to a new pipeline stage.
227
+ * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
228
+ *
229
+ * @remarks Transitions to stage: ModifyServiceRequestStateStageCompleted
230
+ *
231
+ * @param options - Optional settings
232
+ * @param options.journeyId - Associate with a journey
233
+ * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
234
+ * @throws Error if called on a new (unsaved) record
235
+ *
236
+ * @example
237
+ * ```typescript
238
+ * const record = await odinClient.modifyServiceRequests.get(id);
239
+ * await record.moveMsrToComplete().execute();
240
+ *
241
+ * // Dry run (for debugging)
242
+ * const payload = record.moveMsrToComplete().dryRun();
243
+ * ```
244
+ */
245
+ moveMsrToComplete(options?: {
246
+ journeyId?: string;
247
+ }): ActionBuilder;
248
+ /**
249
+ * MoveMsrToFailed
250
+ *
251
+ * Transitions this ModifyServiceRequest record to a new pipeline stage.
252
+ * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
253
+ *
254
+ * @remarks Transitions to stage: ModifyServiceRequestStateStageFailed
255
+ *
256
+ * @param options - Optional settings
257
+ * @param options.journeyId - Associate with a journey
258
+ * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
259
+ * @throws Error if called on a new (unsaved) record
260
+ *
261
+ * @example
262
+ * ```typescript
263
+ * const record = await odinClient.modifyServiceRequests.get(id);
264
+ * await record.moveMsrToFailed().execute();
265
+ *
266
+ * // Dry run (for debugging)
267
+ * const payload = record.moveMsrToFailed().dryRun();
268
+ * ```
269
+ */
270
+ moveMsrToFailed(options?: {
271
+ journeyId?: string;
272
+ }): ActionBuilder;
223
273
  /**
224
274
  * UpdateModifyServiceRequest
225
275
  *
@@ -300,6 +300,64 @@ class ModifyServiceRequestRecord {
300
300
  // ============================================
301
301
  // UPDATE ACTIONS (require existing record)
302
302
  // ============================================
303
+ /**
304
+ * MoveMsrToComplete
305
+ *
306
+ * Transitions this ModifyServiceRequest record to a new pipeline stage.
307
+ * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
308
+ *
309
+ * @remarks Transitions to stage: ModifyServiceRequestStateStageCompleted
310
+ *
311
+ * @param options - Optional settings
312
+ * @param options.journeyId - Associate with a journey
313
+ * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
314
+ * @throws Error if called on a new (unsaved) record
315
+ *
316
+ * @example
317
+ * ```typescript
318
+ * const record = await odinClient.modifyServiceRequests.get(id);
319
+ * await record.moveMsrToComplete().execute();
320
+ *
321
+ * // Dry run (for debugging)
322
+ * const payload = record.moveMsrToComplete().dryRun();
323
+ * ```
324
+ */
325
+ moveMsrToComplete(options) {
326
+ var _a;
327
+ if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
328
+ throw new Error('moveMsrToComplete requires an existing record. Use accessor.get() first.');
329
+ const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MoveMsrToComplete', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'ModifyServiceRequestStateStageCompleted' }, options);
330
+ return new ActionBuilder(this._provider, 'ServiceModule', 'ModifyServiceRequest', payload, () => { this._pendingLinks = []; });
331
+ }
332
+ /**
333
+ * MoveMsrToFailed
334
+ *
335
+ * Transitions this ModifyServiceRequest record to a new pipeline stage.
336
+ * Returns an ActionBuilder - call .execute() to transition or .dryRun() for debugging.
337
+ *
338
+ * @remarks Transitions to stage: ModifyServiceRequestStateStageFailed
339
+ *
340
+ * @param options - Optional settings
341
+ * @param options.journeyId - Associate with a journey
342
+ * @returns ActionBuilder - call .execute() to transition or .dryRun() for payload
343
+ * @throws Error if called on a new (unsaved) record
344
+ *
345
+ * @example
346
+ * ```typescript
347
+ * const record = await odinClient.modifyServiceRequests.get(id);
348
+ * await record.moveMsrToFailed().execute();
349
+ *
350
+ * // Dry run (for debugging)
351
+ * const payload = record.moveMsrToFailed().dryRun();
352
+ * ```
353
+ */
354
+ moveMsrToFailed(options) {
355
+ var _a;
356
+ if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
357
+ throw new Error('moveMsrToFailed requires an existing record. Use accessor.get() first.');
358
+ const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'MoveMsrToFailed', associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined, stageKey: 'ModifyServiceRequestStateStageFailed' }, options);
359
+ return new ActionBuilder(this._provider, 'ServiceModule', 'ModifyServiceRequest', payload, () => { this._pendingLinks = []; });
360
+ }
303
361
  /**
304
362
  * UpdateModifyServiceRequest
305
363
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.233-beta.2",
3
+ "version": "2.0.233-beta.3",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",