@d19n/youfibre-odin-sdk 2.0.266-beta.0 → 2.0.269

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.
Files changed (69) hide show
  1. package/README.md +11 -2
  2. package/dist/actions-v2/InvoiceUpdateDto.d.ts +9 -1
  3. package/dist/actions-v2/PauseCallRecordingDto.d.ts +73 -0
  4. package/dist/actions-v2/PauseCallRecordingDto.js +56 -0
  5. package/dist/actions-v2/ResumeCallRecordingDto.d.ts +73 -0
  6. package/dist/actions-v2/ResumeCallRecordingDto.js +56 -0
  7. package/dist/actions-v2/StampChurnRequestCompletedDto.d.ts +80 -0
  8. package/dist/actions-v2/StampChurnRequestCompletedDto.js +56 -0
  9. package/dist/actions-v2/StampPicRequestCompletedDto.d.ts +80 -0
  10. package/dist/actions-v2/StampPicRequestCompletedDto.js +56 -0
  11. package/dist/actions-v2/UpdateAdditionalCareDto.d.ts +12 -10
  12. package/dist/actions-v2/UpdateCallS3RecordingUrlsDto.d.ts +80 -0
  13. package/dist/actions-v2/UpdateCallS3RecordingUrlsDto.js +56 -0
  14. package/dist/actions-v2/UpdateCampaignCallExternalIdDto.d.ts +73 -0
  15. package/dist/actions-v2/UpdateCampaignCallExternalIdDto.js +56 -0
  16. package/dist/actions-v2/UpdateCaseFromLinkedCallDto.d.ts +79 -0
  17. package/dist/actions-v2/UpdateCaseFromLinkedCallDto.js +56 -0
  18. package/dist/actions-v2/UpdateContactDto.d.ts +8 -1
  19. package/dist/actions-v2/VisitCreateSalesAppDto.d.ts +67 -0
  20. package/dist/actions-v2/VisitCreateSalesAppDto.js +54 -0
  21. package/dist/api-sdk-v2/AddressApi.d.ts +2 -2
  22. package/dist/api-sdk-v2/AddressApi.js +6 -6
  23. package/dist/api-sdk-v2/ContactApi.d.ts +4 -4
  24. package/dist/api-sdk-v2/ContactApi.js +12 -12
  25. package/dist/api-sdk-v2/FileApi.d.ts +2 -0
  26. package/dist/api-sdk-v2/FileApi.js +6 -0
  27. package/dist/api-sdk-v2/WorkOrderApi.d.ts +2 -0
  28. package/dist/api-sdk-v2/WorkOrderApi.js +6 -0
  29. package/dist/api-sdk-v2/YfWifiSurveyApi.d.ts +50 -0
  30. package/dist/api-sdk-v2/YfWifiSurveyApi.js +161 -0
  31. package/dist/db-sdk-v2/AddressDb.d.ts +2 -2
  32. package/dist/db-sdk-v2/AddressDb.js +6 -6
  33. package/dist/db-sdk-v2/ContactDb.d.ts +4 -4
  34. package/dist/db-sdk-v2/ContactDb.js +12 -12
  35. package/dist/db-sdk-v2/FileDb.d.ts +2 -0
  36. package/dist/db-sdk-v2/FileDb.js +6 -0
  37. package/dist/db-sdk-v2/WorkOrderDb.d.ts +2 -0
  38. package/dist/db-sdk-v2/WorkOrderDb.js +6 -0
  39. package/dist/db-sdk-v2/YfWifiSurveyDb.d.ts +122 -0
  40. package/dist/db-sdk-v2/YfWifiSurveyDb.js +210 -0
  41. package/dist/entities-v2/Address.d.ts +3 -3
  42. package/dist/entities-v2/Contact.d.ts +52 -46
  43. package/dist/entities-v2/Contact.js +26 -26
  44. package/dist/entities-v2/CustomerDeviceOnt.d.ts +7 -1
  45. package/dist/entities-v2/CustomerDeviceOnt.js +6 -0
  46. package/dist/entities-v2/File.d.ts +3 -0
  47. package/dist/entities-v2/Order.d.ts +7 -0
  48. package/dist/entities-v2/Order.js +2 -0
  49. package/dist/entities-v2/PaymentMethodRefund.d.ts +19 -0
  50. package/dist/entities-v2/PaymentMethodRefund.js +8 -0
  51. package/dist/entities-v2/WorkOrder.d.ts +7 -0
  52. package/dist/entities-v2/WorkOrder.js +5 -1
  53. package/dist/entities-v2/YfWifiSurvey.d.ts +164 -0
  54. package/dist/entities-v2/YfWifiSurvey.js +102 -0
  55. package/dist/records-v2/AddressRecord.d.ts +20 -20
  56. package/dist/records-v2/AddressRecord.js +33 -33
  57. package/dist/records-v2/CallRecord.d.ts +108 -0
  58. package/dist/records-v2/CallRecord.js +116 -0
  59. package/dist/records-v2/CaseRecord.d.ts +28 -0
  60. package/dist/records-v2/CaseRecord.js +37 -0
  61. package/dist/records-v2/ChurnRequestRecord.d.ts +28 -0
  62. package/dist/records-v2/ChurnRequestRecord.js +37 -0
  63. package/dist/records-v2/ContactRecord.d.ts +26 -27
  64. package/dist/records-v2/ContactRecord.js +40 -48
  65. package/dist/records-v2/PICRequestRecord.d.ts +28 -0
  66. package/dist/records-v2/PICRequestRecord.js +37 -0
  67. package/dist/records-v2/VisitRecord.d.ts +29 -0
  68. package/dist/records-v2/VisitRecord.js +36 -0
  69. package/package.json +3 -3
package/README.md CHANGED
@@ -124,7 +124,7 @@ await workOrder.completeWorkOrder({ ... });
124
124
 
125
125
  ## Entities
126
126
 
127
- This SDK includes **176** entities across **12** modules.
127
+ This SDK includes **177** entities across **12** modules.
128
128
 
129
129
  ### CrmModule
130
130
 
@@ -260,6 +260,7 @@ This SDK includes **176** entities across **12** modules.
260
260
  | **YfStockCount** | YfStockCount Entity Definition | OUTCOME_FORM |
261
261
  | **YfToolAudit** | YfToolAudit Entity Definition | OUTCOME_FORM |
262
262
  | **YfVanAudit** | YfVanAudit Entity Definition | OUTCOME_FORM |
263
+ | **YfWifiSurvey** | YfWifiSurvey Entity Definition | DEFAULT |
263
264
 
264
265
  ### ServiceModule
265
266
 
@@ -364,7 +365,7 @@ This SDK includes **176** entities across **12** modules.
364
365
 
365
366
  ## Actions
366
367
 
367
- This SDK includes **800** actions.
368
+ This SDK includes **808** actions.
368
369
 
369
370
  ### Action Types
370
371
 
@@ -859,6 +860,7 @@ This SDK includes **800** actions.
859
860
  | `UpdateAdditionalNote` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateAdditionalNote |
860
861
  | `UpdateCaseChannelOnCall` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseChannelOnCall |
861
862
  | `UpdateCaseCsat` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseCsat |
863
+ | `UpdateCaseFromLinkedCall` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseFromLinkedCall |
862
864
  | `UpdateCaseOnDialAttempt` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseOnDialAttempt |
863
865
  | `UpdateCaseOnDialConnected` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateCaseOnDialConnected |
864
866
  | `UpdateFormalComplaint` | UPDATE | k1.t-hEOJjsDb.SupportModule.Case.Update.UpdateFormalComplaint |
@@ -1053,6 +1055,7 @@ This SDK includes **800** actions.
1053
1055
  | `DefaultUpdateChurnRequest` | UPDATE | k1.t-hEOJjsDb.OrderModule.ChurnRequest.Update.DefaultUpdateChurnRequest |
1054
1056
  | `MoveOrderFromDeactivatedToCancelled` | CREATE | k1.t-hEOJjsDb.OrderModule.ChurnRequest.Create.CreateChurnRequest |
1055
1057
  | `MoveOrderFromPendingCancellationToCancelled` | CREATE | k1.t-hEOJjsDb.OrderModule.ChurnRequest.Create.CreateChurnRequest |
1058
+ | `StampChurnRequestCompleted` | UPDATE | k1.t-hEOJjsDb.OrderModule.ChurnRequest.Update.StampChurnRequestCompleted |
1056
1059
 
1057
1060
  **CompleteChurnRequestFlow Target Stages:** `ChurnRequestStageDone`
1058
1061
 
@@ -1105,6 +1108,7 @@ This SDK includes **800** actions.
1105
1108
  | `CreatePicRequest` | CREATE | k1.t-hEOJjsDb.OrderModule.PICRequest.Create.CreatePICRequest |
1106
1109
  | `DefaultUpdatePicRequest` | UPDATE | k1.t-hEOJjsDb.OrderModule.PICRequest.Update.DefaultUpdatePICRequest |
1107
1110
  | `OverrideMovePicToInProgress` | STAGE_TRANSITION | k1.t-hEOJjsDb.OrderModule.PICRequest.Transition.OverrideMovePICToInProgress |
1111
+ | `StampPicRequestCompleted` | UPDATE | k1.t-hEOJjsDb.OrderModule.PICRequest.Update.StampPicRequestCompleted |
1108
1112
 
1109
1113
  **CompletePicRequestFlow Target Stages:** `PICRequestStageDone`
1110
1114
 
@@ -1354,6 +1358,8 @@ This SDK includes **800** actions.
1354
1358
  | `CreateInboundCall` | CREATE | k1.t-hEOJjsDb.NotificationModule.Call.Create.CreateInboundCall |
1355
1359
  | `CreateMissedIncomingCall` | CREATE | k1.t-hEOJjsDb.NotificationModule.Call.Create.CreateMissedIncomingCall |
1356
1360
  | `CreateOutboundCall` | CREATE | k1.t-hEOJjsDb.NotificationModule.Call.Create.CreateOutboundCall |
1361
+ | `PauseCallRecording` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.PauseCallRecording |
1362
+ | `ResumeCallRecording` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.ResumeCallRecording |
1357
1363
  | `UpdateCallAnalytics` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallAnalytics |
1358
1364
  | `UpdateCallInsights` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallInsights |
1359
1365
  | `UpdateCallOnCampaignDialAmdResult` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnCampaignDialAmdResult |
@@ -1365,7 +1371,9 @@ This SDK includes **800** actions.
1365
1371
  | `UpdateCallOnOutboundDialAction` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnOutboundDialAction |
1366
1372
  | `UpdateCallOnTaskRouterAssign` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnTaskRouterAssign |
1367
1373
  | `UpdateCallRecordingDetails` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallRecordingDetails |
1374
+ | `UpdateCallS3RecordingUrls` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallS3RecordingUrls |
1368
1375
  | `UpdateCallTranscriptionUrl` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallTranscriptionUrl |
1376
+ | `UpdateCampaignCallExternalId` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCampaignCallExternalId |
1369
1377
 
1370
1378
  #### Reward
1371
1379
 
@@ -2238,6 +2246,7 @@ This SDK includes **800** actions.
2238
2246
  | Action | Type | Event |
2239
2247
  |--------|------|-------|
2240
2248
  | `VisitCreate` | CREATE | k1.t-hEOJjsDb.CrmModule.Visit.Create.VisitCreate |
2249
+ | `VisitCreateSalesApp` | CREATE | k1.t-hEOJjsDb.CrmModule.Visit.Create.VisitCreateSalesApp |
2241
2250
  | `VisitUpdate` | UPDATE | k1.t-hEOJjsDb.CrmModule.Visit.Update.VisitUpdate |
2242
2251
 
2243
2252
  #### CustomerPhonePorting
@@ -22,7 +22,7 @@ export interface InvoiceUpdateMessage extends OdinRecordUpdatedEvent<InvoiceUpda
22
22
  * Properties for InvoiceUpdate action
23
23
  *
24
24
  * @property Required fields: 0
25
- * @property Optional fields: 3
25
+ * @property Optional fields: 4
26
26
  */
27
27
  export interface InvoiceUpdateProperties {
28
28
  /**
@@ -46,6 +46,14 @@ export interface InvoiceUpdateProperties {
46
46
  * @type {ENUM}
47
47
  */
48
48
  Status?: string | null;
49
+ /**
50
+ * Billing period end
51
+ *
52
+ * Billing period end date (Finance - Invoice)
53
+ * @type {DATE}
54
+ * @format DD/MM/YYYY
55
+ */
56
+ BillingPeriodEnd?: string | null;
49
57
  }
50
58
  /**
51
59
  * InvoiceUpdate
@@ -0,0 +1,73 @@
1
+ /**
2
+ * PauseCallRecording Action DTO
3
+ *
4
+ * Records that the agent paused recording on this call — the DPA-capture pause, where the customer is about to read out card details. Distinct from UpdateCallOnOutboundCallCompleted, which also carries RecordingStatus but is the call-completion event and requires the RecordingSid/Duration/Url triple that a mid-call pause does not have.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Call
8
+ * @actionKey PauseCallRecording
9
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.PauseCallRecording
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 PauseCallRecording updated events
16
+ *
17
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.PauseCallRecording
18
+ */
19
+ export interface PauseCallRecordingMessage extends OdinRecordUpdatedEvent<PauseCallRecordingDto, PauseCallRecordingProperties> {
20
+ }
21
+ /**
22
+ * Properties for PauseCallRecording action
23
+ *
24
+ * @property Required fields: 1
25
+ * @property Optional fields: 0
26
+ */
27
+ export interface PauseCallRecordingProperties {
28
+ /**
29
+ * Recording status
30
+ *
31
+ * RecordingStatus (Communications - Call)
32
+ * @type {TEXT}
33
+ * @required
34
+ */
35
+ RecordingStatus: string;
36
+ }
37
+ /**
38
+ * Pause call recording
39
+ *
40
+ * Records that the agent paused recording on this call — the DPA-capture pause, where the customer is about to read out card details. Distinct from UpdateCallOnOutboundCallCompleted, which also carries RecordingStatus but is the call-completion event and requires the RecordingSid/Duration/Url triple that a mid-call pause does not have.
41
+ *
42
+ * @actionType UPDATE - Updates an existing Call record
43
+ * @module NotificationModule
44
+ * @entity Call
45
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.PauseCallRecording
46
+ * @permission schema.action.pausecallrecording.trigger
47
+ * @benchmark This action is tracked for performance benchmarks
48
+ */
49
+ export declare class PauseCallRecordingDto extends OdinRecordUpdateDto<PauseCallRecordingProperties> {
50
+ /** Used by SDK generators to identify action type */
51
+ static readonly ACTION_TYPE = "UPDATE";
52
+ static readonly ACTION_KEY = "PauseCallRecording";
53
+ static readonly MODULE_NAME = "NotificationModule";
54
+ static readonly ENTITIES: string[];
55
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Call.Update.PauseCallRecording";
56
+ static readonly PERMISSION = "schema.action.pausecallrecording.trigger";
57
+ /** Step metadata - entity this action targets */
58
+ static readonly STEP_ENTITY = "NotificationModule:Call";
59
+ static readonly STEP_SCHEMA_ID = "e157f15c-6846-4bfb-bc92-aed4c4084e9f";
60
+ static readonly STEP_SCHEMA_ACTION_ID = "02358fec-5f5e-496f-b8ef-17a7e005b17f";
61
+ static readonly AUTO_LINK_PARENT = false;
62
+ readonly actionName: string;
63
+ readonly schemaActionId: string;
64
+ readonly entity: string;
65
+ constructor(record: OdinRecord<any> | {
66
+ id: string;
67
+ entity: string;
68
+ type?: string;
69
+ }, properties: PauseCallRecordingProperties, options?: {
70
+ journeyId?: string;
71
+ stageKey?: string;
72
+ });
73
+ }
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /**
3
+ * PauseCallRecording Action DTO
4
+ *
5
+ * Records that the agent paused recording on this call — the DPA-capture pause, where the customer is about to read out card details. Distinct from UpdateCallOnOutboundCallCompleted, which also carries RecordingStatus but is the call-completion event and requires the RecordingSid/Duration/Url triple that a mid-call pause does not have.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Call
9
+ * @actionKey PauseCallRecording
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.PauseCallRecording
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.PauseCallRecordingDto = void 0;
16
+ const core_1 = require("@d19n/odin-types/dist/core");
17
+ /**
18
+ * Pause call recording
19
+ *
20
+ * Records that the agent paused recording on this call — the DPA-capture pause, where the customer is about to read out card details. Distinct from UpdateCallOnOutboundCallCompleted, which also carries RecordingStatus but is the call-completion event and requires the RecordingSid/Duration/Url triple that a mid-call pause does not have.
21
+ *
22
+ * @actionType UPDATE - Updates an existing Call record
23
+ * @module NotificationModule
24
+ * @entity Call
25
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.PauseCallRecording
26
+ * @permission schema.action.pausecallrecording.trigger
27
+ * @benchmark This action is tracked for performance benchmarks
28
+ */
29
+ class PauseCallRecordingDto extends core_1.OdinRecordUpdateDto {
30
+ constructor(record, properties, options) {
31
+ super({
32
+ id: record.id,
33
+ entity: record.entity,
34
+ type: record.type,
35
+ properties,
36
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
37
+ stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
38
+ });
39
+ this.actionName = 'PauseCallRecording';
40
+ this.schemaActionId = '02358fec-5f5e-496f-b8ef-17a7e005b17f';
41
+ this.entity = 'NotificationModule:Call';
42
+ }
43
+ }
44
+ exports.PauseCallRecordingDto = PauseCallRecordingDto;
45
+ /** Used by SDK generators to identify action type */
46
+ PauseCallRecordingDto.ACTION_TYPE = 'UPDATE';
47
+ PauseCallRecordingDto.ACTION_KEY = 'PauseCallRecording';
48
+ PauseCallRecordingDto.MODULE_NAME = 'NotificationModule';
49
+ PauseCallRecordingDto.ENTITIES = ['Call'];
50
+ PauseCallRecordingDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Call.Update.PauseCallRecording';
51
+ PauseCallRecordingDto.PERMISSION = 'schema.action.pausecallrecording.trigger';
52
+ /** Step metadata - entity this action targets */
53
+ PauseCallRecordingDto.STEP_ENTITY = 'NotificationModule:Call';
54
+ PauseCallRecordingDto.STEP_SCHEMA_ID = 'e157f15c-6846-4bfb-bc92-aed4c4084e9f';
55
+ PauseCallRecordingDto.STEP_SCHEMA_ACTION_ID = '02358fec-5f5e-496f-b8ef-17a7e005b17f';
56
+ PauseCallRecordingDto.AUTO_LINK_PARENT = false;
@@ -0,0 +1,73 @@
1
+ /**
2
+ * ResumeCallRecording Action DTO
3
+ *
4
+ * Records that the agent resumed recording after a DPA-capture pause. Paired with PauseCallRecording; kept as its own action because resuming and pausing are separate business events even though the payload shape is identical.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Call
8
+ * @actionKey ResumeCallRecording
9
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.ResumeCallRecording
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 ResumeCallRecording updated events
16
+ *
17
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.ResumeCallRecording
18
+ */
19
+ export interface ResumeCallRecordingMessage extends OdinRecordUpdatedEvent<ResumeCallRecordingDto, ResumeCallRecordingProperties> {
20
+ }
21
+ /**
22
+ * Properties for ResumeCallRecording action
23
+ *
24
+ * @property Required fields: 1
25
+ * @property Optional fields: 0
26
+ */
27
+ export interface ResumeCallRecordingProperties {
28
+ /**
29
+ * Recording status
30
+ *
31
+ * RecordingStatus (Communications - Call)
32
+ * @type {TEXT}
33
+ * @required
34
+ */
35
+ RecordingStatus: string;
36
+ }
37
+ /**
38
+ * Resume call recording
39
+ *
40
+ * Records that the agent resumed recording after a DPA-capture pause. Paired with PauseCallRecording; kept as its own action because resuming and pausing are separate business events even though the payload shape is identical.
41
+ *
42
+ * @actionType UPDATE - Updates an existing Call record
43
+ * @module NotificationModule
44
+ * @entity Call
45
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.ResumeCallRecording
46
+ * @permission schema.action.resumecallrecording.trigger
47
+ * @benchmark This action is tracked for performance benchmarks
48
+ */
49
+ export declare class ResumeCallRecordingDto extends OdinRecordUpdateDto<ResumeCallRecordingProperties> {
50
+ /** Used by SDK generators to identify action type */
51
+ static readonly ACTION_TYPE = "UPDATE";
52
+ static readonly ACTION_KEY = "ResumeCallRecording";
53
+ static readonly MODULE_NAME = "NotificationModule";
54
+ static readonly ENTITIES: string[];
55
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Call.Update.ResumeCallRecording";
56
+ static readonly PERMISSION = "schema.action.resumecallrecording.trigger";
57
+ /** Step metadata - entity this action targets */
58
+ static readonly STEP_ENTITY = "NotificationModule:Call";
59
+ static readonly STEP_SCHEMA_ID = "e157f15c-6846-4bfb-bc92-aed4c4084e9f";
60
+ static readonly STEP_SCHEMA_ACTION_ID = "106b3ce3-2722-4e46-a29b-605799b05337";
61
+ static readonly AUTO_LINK_PARENT = false;
62
+ readonly actionName: string;
63
+ readonly schemaActionId: string;
64
+ readonly entity: string;
65
+ constructor(record: OdinRecord<any> | {
66
+ id: string;
67
+ entity: string;
68
+ type?: string;
69
+ }, properties: ResumeCallRecordingProperties, options?: {
70
+ journeyId?: string;
71
+ stageKey?: string;
72
+ });
73
+ }
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /**
3
+ * ResumeCallRecording Action DTO
4
+ *
5
+ * Records that the agent resumed recording after a DPA-capture pause. Paired with PauseCallRecording; kept as its own action because resuming and pausing are separate business events even though the payload shape is identical.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Call
9
+ * @actionKey ResumeCallRecording
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.ResumeCallRecording
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.ResumeCallRecordingDto = void 0;
16
+ const core_1 = require("@d19n/odin-types/dist/core");
17
+ /**
18
+ * Resume call recording
19
+ *
20
+ * Records that the agent resumed recording after a DPA-capture pause. Paired with PauseCallRecording; kept as its own action because resuming and pausing are separate business events even though the payload shape is identical.
21
+ *
22
+ * @actionType UPDATE - Updates an existing Call record
23
+ * @module NotificationModule
24
+ * @entity Call
25
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.ResumeCallRecording
26
+ * @permission schema.action.resumecallrecording.trigger
27
+ * @benchmark This action is tracked for performance benchmarks
28
+ */
29
+ class ResumeCallRecordingDto extends core_1.OdinRecordUpdateDto {
30
+ constructor(record, properties, options) {
31
+ super({
32
+ id: record.id,
33
+ entity: record.entity,
34
+ type: record.type,
35
+ properties,
36
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
37
+ stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
38
+ });
39
+ this.actionName = 'ResumeCallRecording';
40
+ this.schemaActionId = '106b3ce3-2722-4e46-a29b-605799b05337';
41
+ this.entity = 'NotificationModule:Call';
42
+ }
43
+ }
44
+ exports.ResumeCallRecordingDto = ResumeCallRecordingDto;
45
+ /** Used by SDK generators to identify action type */
46
+ ResumeCallRecordingDto.ACTION_TYPE = 'UPDATE';
47
+ ResumeCallRecordingDto.ACTION_KEY = 'ResumeCallRecording';
48
+ ResumeCallRecordingDto.MODULE_NAME = 'NotificationModule';
49
+ ResumeCallRecordingDto.ENTITIES = ['Call'];
50
+ ResumeCallRecordingDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Call.Update.ResumeCallRecording';
51
+ ResumeCallRecordingDto.PERMISSION = 'schema.action.resumecallrecording.trigger';
52
+ /** Step metadata - entity this action targets */
53
+ ResumeCallRecordingDto.STEP_ENTITY = 'NotificationModule:Call';
54
+ ResumeCallRecordingDto.STEP_SCHEMA_ID = 'e157f15c-6846-4bfb-bc92-aed4c4084e9f';
55
+ ResumeCallRecordingDto.STEP_SCHEMA_ACTION_ID = '106b3ce3-2722-4e46-a29b-605799b05337';
56
+ ResumeCallRecordingDto.AUTO_LINK_PARENT = false;
@@ -0,0 +1,80 @@
1
+ /**
2
+ * StampChurnRequestCompleted Action DTO
3
+ *
4
+ * Stamps the Done-stage audit fields on a ChurnRequest. Written by the orders RMQ subscriber ChurnRequestsRabbitmqHandler when the record reaches ChurnRequestStageDone — CompletedBy from the event principal, CompletedDate from the clock. Not operator-facing: both columns are hidden.
5
+ *
6
+ * @module OrderModule
7
+ * @entity ChurnRequest
8
+ * @actionKey StampChurnRequestCompleted
9
+ * @event k1.t-hEOJjsDb.OrderModule.ChurnRequest.Update.StampChurnRequestCompleted
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 StampChurnRequestCompleted updated events
16
+ *
17
+ * @event k1.t-hEOJjsDb.OrderModule.ChurnRequest.Update.StampChurnRequestCompleted
18
+ */
19
+ export interface StampChurnRequestCompletedMessage extends OdinRecordUpdatedEvent<StampChurnRequestCompletedDto, StampChurnRequestCompletedProperties> {
20
+ }
21
+ /**
22
+ * Properties for StampChurnRequestCompleted action
23
+ *
24
+ * @property Required fields: 0
25
+ * @property Optional fields: 2
26
+ */
27
+ export interface StampChurnRequestCompletedProperties {
28
+ /**
29
+ * Completed by
30
+ *
31
+ * the user that moved the record to done (Sales - ChurnRequest)
32
+ * @type {TEXT}
33
+ */
34
+ CompletedBy?: string | null;
35
+ /**
36
+ * Completed date
37
+ *
38
+ * the date the record was moved to done (Sales - ChurnRequest)
39
+ * @type {DATE}
40
+ * @format DD/MM/YYYY
41
+ */
42
+ CompletedDate?: string | null;
43
+ }
44
+ /**
45
+ * Record who completed the churn request, and when
46
+ *
47
+ * Stamps the Done-stage audit fields on a ChurnRequest. Written by the orders RMQ subscriber ChurnRequestsRabbitmqHandler when the record reaches ChurnRequestStageDone — CompletedBy from the event principal, CompletedDate from the clock. Not operator-facing: both columns are hidden.
48
+ *
49
+ * @actionType UPDATE - Updates an existing ChurnRequest record
50
+ * @module OrderModule
51
+ * @entity ChurnRequest
52
+ * @event k1.t-hEOJjsDb.OrderModule.ChurnRequest.Update.StampChurnRequestCompleted
53
+ * @permission schema.action.stampchurnrequestcompleted.trigger
54
+ * @benchmark This action is tracked for performance benchmarks
55
+ */
56
+ export declare class StampChurnRequestCompletedDto extends OdinRecordUpdateDto<StampChurnRequestCompletedProperties> {
57
+ /** Used by SDK generators to identify action type */
58
+ static readonly ACTION_TYPE = "UPDATE";
59
+ static readonly ACTION_KEY = "StampChurnRequestCompleted";
60
+ static readonly MODULE_NAME = "OrderModule";
61
+ static readonly ENTITIES: string[];
62
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.ChurnRequest.Update.StampChurnRequestCompleted";
63
+ static readonly PERMISSION = "schema.action.stampchurnrequestcompleted.trigger";
64
+ /** Step metadata - entity this action targets */
65
+ static readonly STEP_ENTITY = "OrderModule:ChurnRequest";
66
+ static readonly STEP_SCHEMA_ID = "aec13a3b-3a34-43aa-9cc9-dcf8c1637ab6";
67
+ static readonly STEP_SCHEMA_ACTION_ID = "e9e7f7c4-7d75-4a26-a478-7672c7b10c37";
68
+ static readonly AUTO_LINK_PARENT = false;
69
+ readonly actionName: string;
70
+ readonly schemaActionId: string;
71
+ readonly entity: string;
72
+ constructor(record: OdinRecord<any> | {
73
+ id: string;
74
+ entity: string;
75
+ type?: string;
76
+ }, properties: StampChurnRequestCompletedProperties, options?: {
77
+ journeyId?: string;
78
+ stageKey?: string;
79
+ });
80
+ }
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /**
3
+ * StampChurnRequestCompleted Action DTO
4
+ *
5
+ * Stamps the Done-stage audit fields on a ChurnRequest. Written by the orders RMQ subscriber ChurnRequestsRabbitmqHandler when the record reaches ChurnRequestStageDone — CompletedBy from the event principal, CompletedDate from the clock. Not operator-facing: both columns are hidden.
6
+ *
7
+ * @module OrderModule
8
+ * @entity ChurnRequest
9
+ * @actionKey StampChurnRequestCompleted
10
+ * @event k1.t-hEOJjsDb.OrderModule.ChurnRequest.Update.StampChurnRequestCompleted
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.StampChurnRequestCompletedDto = void 0;
16
+ const core_1 = require("@d19n/odin-types/dist/core");
17
+ /**
18
+ * Record who completed the churn request, and when
19
+ *
20
+ * Stamps the Done-stage audit fields on a ChurnRequest. Written by the orders RMQ subscriber ChurnRequestsRabbitmqHandler when the record reaches ChurnRequestStageDone — CompletedBy from the event principal, CompletedDate from the clock. Not operator-facing: both columns are hidden.
21
+ *
22
+ * @actionType UPDATE - Updates an existing ChurnRequest record
23
+ * @module OrderModule
24
+ * @entity ChurnRequest
25
+ * @event k1.t-hEOJjsDb.OrderModule.ChurnRequest.Update.StampChurnRequestCompleted
26
+ * @permission schema.action.stampchurnrequestcompleted.trigger
27
+ * @benchmark This action is tracked for performance benchmarks
28
+ */
29
+ class StampChurnRequestCompletedDto extends core_1.OdinRecordUpdateDto {
30
+ constructor(record, properties, options) {
31
+ super({
32
+ id: record.id,
33
+ entity: record.entity,
34
+ type: record.type,
35
+ properties,
36
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
37
+ stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
38
+ });
39
+ this.actionName = 'StampChurnRequestCompleted';
40
+ this.schemaActionId = 'e9e7f7c4-7d75-4a26-a478-7672c7b10c37';
41
+ this.entity = 'OrderModule:ChurnRequest';
42
+ }
43
+ }
44
+ exports.StampChurnRequestCompletedDto = StampChurnRequestCompletedDto;
45
+ /** Used by SDK generators to identify action type */
46
+ StampChurnRequestCompletedDto.ACTION_TYPE = 'UPDATE';
47
+ StampChurnRequestCompletedDto.ACTION_KEY = 'StampChurnRequestCompleted';
48
+ StampChurnRequestCompletedDto.MODULE_NAME = 'OrderModule';
49
+ StampChurnRequestCompletedDto.ENTITIES = ['ChurnRequest'];
50
+ StampChurnRequestCompletedDto.EVENT_NAME = 'k1.t-hEOJjsDb.OrderModule.ChurnRequest.Update.StampChurnRequestCompleted';
51
+ StampChurnRequestCompletedDto.PERMISSION = 'schema.action.stampchurnrequestcompleted.trigger';
52
+ /** Step metadata - entity this action targets */
53
+ StampChurnRequestCompletedDto.STEP_ENTITY = 'OrderModule:ChurnRequest';
54
+ StampChurnRequestCompletedDto.STEP_SCHEMA_ID = 'aec13a3b-3a34-43aa-9cc9-dcf8c1637ab6';
55
+ StampChurnRequestCompletedDto.STEP_SCHEMA_ACTION_ID = 'e9e7f7c4-7d75-4a26-a478-7672c7b10c37';
56
+ StampChurnRequestCompletedDto.AUTO_LINK_PARENT = false;
@@ -0,0 +1,80 @@
1
+ /**
2
+ * StampPicRequestCompleted Action DTO
3
+ *
4
+ * Stamps the Done-stage audit fields on a PICRequest. Written by the orders RMQ subscriber PicRequestsRabbitmqHandler when the record reaches its success stage — CompletedBy from the event principal, CompletedDate from the clock. Not operator-facing: both columns are hidden.
5
+ *
6
+ * @module OrderModule
7
+ * @entity PICRequest
8
+ * @actionKey StampPicRequestCompleted
9
+ * @event k1.t-hEOJjsDb.OrderModule.PICRequest.Update.StampPicRequestCompleted
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 StampPicRequestCompleted updated events
16
+ *
17
+ * @event k1.t-hEOJjsDb.OrderModule.PICRequest.Update.StampPicRequestCompleted
18
+ */
19
+ export interface StampPicRequestCompletedMessage extends OdinRecordUpdatedEvent<StampPicRequestCompletedDto, StampPicRequestCompletedProperties> {
20
+ }
21
+ /**
22
+ * Properties for StampPicRequestCompleted action
23
+ *
24
+ * @property Required fields: 0
25
+ * @property Optional fields: 2
26
+ */
27
+ export interface StampPicRequestCompletedProperties {
28
+ /**
29
+ * Completed by
30
+ *
31
+ * The person who moved the PICRequest to done (Sales - PICRequest)
32
+ * @type {TEXT}
33
+ */
34
+ CompletedBy?: string | null;
35
+ /**
36
+ * Completed date
37
+ *
38
+ * the date the PICRequest was moved to done (Sales - PICRequest)
39
+ * @type {DATE}
40
+ * @format DD/MM/YYYY
41
+ */
42
+ CompletedDate?: string | null;
43
+ }
44
+ /**
45
+ * Record who completed the PIC request, and when
46
+ *
47
+ * Stamps the Done-stage audit fields on a PICRequest. Written by the orders RMQ subscriber PicRequestsRabbitmqHandler when the record reaches its success stage — CompletedBy from the event principal, CompletedDate from the clock. Not operator-facing: both columns are hidden.
48
+ *
49
+ * @actionType UPDATE - Updates an existing PICRequest record
50
+ * @module OrderModule
51
+ * @entity PICRequest
52
+ * @event k1.t-hEOJjsDb.OrderModule.PICRequest.Update.StampPicRequestCompleted
53
+ * @permission schema.action.stamppicrequestcompleted.trigger
54
+ * @benchmark This action is tracked for performance benchmarks
55
+ */
56
+ export declare class StampPicRequestCompletedDto extends OdinRecordUpdateDto<StampPicRequestCompletedProperties> {
57
+ /** Used by SDK generators to identify action type */
58
+ static readonly ACTION_TYPE = "UPDATE";
59
+ static readonly ACTION_KEY = "StampPicRequestCompleted";
60
+ static readonly MODULE_NAME = "OrderModule";
61
+ static readonly ENTITIES: string[];
62
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.OrderModule.PICRequest.Update.StampPicRequestCompleted";
63
+ static readonly PERMISSION = "schema.action.stamppicrequestcompleted.trigger";
64
+ /** Step metadata - entity this action targets */
65
+ static readonly STEP_ENTITY = "OrderModule:PICRequest";
66
+ static readonly STEP_SCHEMA_ID = "5d43f05b-29a7-4cb7-9eb4-95517cc18ba1";
67
+ static readonly STEP_SCHEMA_ACTION_ID = "0ee20496-2bfd-47b2-8f19-d393875af028";
68
+ static readonly AUTO_LINK_PARENT = false;
69
+ readonly actionName: string;
70
+ readonly schemaActionId: string;
71
+ readonly entity: string;
72
+ constructor(record: OdinRecord<any> | {
73
+ id: string;
74
+ entity: string;
75
+ type?: string;
76
+ }, properties: StampPicRequestCompletedProperties, options?: {
77
+ journeyId?: string;
78
+ stageKey?: string;
79
+ });
80
+ }
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /**
3
+ * StampPicRequestCompleted Action DTO
4
+ *
5
+ * Stamps the Done-stage audit fields on a PICRequest. Written by the orders RMQ subscriber PicRequestsRabbitmqHandler when the record reaches its success stage — CompletedBy from the event principal, CompletedDate from the clock. Not operator-facing: both columns are hidden.
6
+ *
7
+ * @module OrderModule
8
+ * @entity PICRequest
9
+ * @actionKey StampPicRequestCompleted
10
+ * @event k1.t-hEOJjsDb.OrderModule.PICRequest.Update.StampPicRequestCompleted
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.StampPicRequestCompletedDto = void 0;
16
+ const core_1 = require("@d19n/odin-types/dist/core");
17
+ /**
18
+ * Record who completed the PIC request, and when
19
+ *
20
+ * Stamps the Done-stage audit fields on a PICRequest. Written by the orders RMQ subscriber PicRequestsRabbitmqHandler when the record reaches its success stage — CompletedBy from the event principal, CompletedDate from the clock. Not operator-facing: both columns are hidden.
21
+ *
22
+ * @actionType UPDATE - Updates an existing PICRequest record
23
+ * @module OrderModule
24
+ * @entity PICRequest
25
+ * @event k1.t-hEOJjsDb.OrderModule.PICRequest.Update.StampPicRequestCompleted
26
+ * @permission schema.action.stamppicrequestcompleted.trigger
27
+ * @benchmark This action is tracked for performance benchmarks
28
+ */
29
+ class StampPicRequestCompletedDto extends core_1.OdinRecordUpdateDto {
30
+ constructor(record, properties, options) {
31
+ super({
32
+ id: record.id,
33
+ entity: record.entity,
34
+ type: record.type,
35
+ properties,
36
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
37
+ stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
38
+ });
39
+ this.actionName = 'StampPicRequestCompleted';
40
+ this.schemaActionId = '0ee20496-2bfd-47b2-8f19-d393875af028';
41
+ this.entity = 'OrderModule:PICRequest';
42
+ }
43
+ }
44
+ exports.StampPicRequestCompletedDto = StampPicRequestCompletedDto;
45
+ /** Used by SDK generators to identify action type */
46
+ StampPicRequestCompletedDto.ACTION_TYPE = 'UPDATE';
47
+ StampPicRequestCompletedDto.ACTION_KEY = 'StampPicRequestCompleted';
48
+ StampPicRequestCompletedDto.MODULE_NAME = 'OrderModule';
49
+ StampPicRequestCompletedDto.ENTITIES = ['PICRequest'];
50
+ StampPicRequestCompletedDto.EVENT_NAME = 'k1.t-hEOJjsDb.OrderModule.PICRequest.Update.StampPicRequestCompleted';
51
+ StampPicRequestCompletedDto.PERMISSION = 'schema.action.stamppicrequestcompleted.trigger';
52
+ /** Step metadata - entity this action targets */
53
+ StampPicRequestCompletedDto.STEP_ENTITY = 'OrderModule:PICRequest';
54
+ StampPicRequestCompletedDto.STEP_SCHEMA_ID = '5d43f05b-29a7-4cb7-9eb4-95517cc18ba1';
55
+ StampPicRequestCompletedDto.STEP_SCHEMA_ACTION_ID = '0ee20496-2bfd-47b2-8f19-d393875af028';
56
+ StampPicRequestCompletedDto.AUTO_LINK_PARENT = false;
@@ -21,10 +21,20 @@ export interface UpdateAdditionalCareMessage extends OdinRecordUpdatedEvent<Upda
21
21
  /**
22
22
  * Properties for UpdateAdditionalCare action
23
23
  *
24
- * @property Required fields: 0
25
- * @property Optional fields: 6
24
+ * @property Required fields: 1
25
+ * @property Optional fields: 5
26
26
  */
27
27
  export interface UpdateAdditionalCareProperties {
28
+ /**
29
+ * Additional Care Consent
30
+ *
31
+ * Customer consent for recording additional care requiremetns (Sales - Contact)
32
+ * @type {BOOLEAN}
33
+ * @required
34
+ * @visibleWhen TelecareAlarm = ["YES"] AND MedicallyDependant = ["YES"]
35
+ * @validWhen AdditionalCareConsent eq [true]
36
+ */
37
+ AdditionalCareConsent: boolean;
28
38
  /**
29
39
  * Medically Dependant
30
40
  *
@@ -53,14 +63,6 @@ export interface UpdateAdditionalCareProperties {
53
63
  * @type {TEXT_LONG}
54
64
  */
55
65
  AdditionalCareNotes?: string | null;
56
- /**
57
- * Additional Care Consent
58
- *
59
- * Customer consent for recording additional care requiremetns (Sales - Contact)
60
- * @type {BOOLEAN}
61
- * @requiredWhen TelecareAlarm = ["YES"] AND MedicallyDependant = ["YES"]
62
- */
63
- AdditionalCareConsent?: boolean | null;
64
66
  }
65
67
  /**
66
68
  * Additional Care