@d19n/youfibre-odin-sdk 2.0.266 → 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 (61) hide show
  1. package/README.md +9 -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/UpdateAdditionalCareDto.d.ts +12 -10
  8. package/dist/actions-v2/UpdateCallS3RecordingUrlsDto.d.ts +80 -0
  9. package/dist/actions-v2/UpdateCallS3RecordingUrlsDto.js +56 -0
  10. package/dist/actions-v2/UpdateCampaignCallExternalIdDto.d.ts +73 -0
  11. package/dist/actions-v2/UpdateCampaignCallExternalIdDto.js +56 -0
  12. package/dist/actions-v2/UpdateCaseFromLinkedCallDto.d.ts +79 -0
  13. package/dist/actions-v2/UpdateCaseFromLinkedCallDto.js +56 -0
  14. package/dist/actions-v2/UpdateContactDto.d.ts +8 -1
  15. package/dist/actions-v2/VisitCreateSalesAppDto.d.ts +67 -0
  16. package/dist/actions-v2/VisitCreateSalesAppDto.js +54 -0
  17. package/dist/api-sdk-v2/AddressApi.d.ts +2 -2
  18. package/dist/api-sdk-v2/AddressApi.js +6 -6
  19. package/dist/api-sdk-v2/ContactApi.d.ts +4 -4
  20. package/dist/api-sdk-v2/ContactApi.js +12 -12
  21. package/dist/api-sdk-v2/FileApi.d.ts +2 -0
  22. package/dist/api-sdk-v2/FileApi.js +6 -0
  23. package/dist/api-sdk-v2/WorkOrderApi.d.ts +2 -0
  24. package/dist/api-sdk-v2/WorkOrderApi.js +6 -0
  25. package/dist/api-sdk-v2/YfWifiSurveyApi.d.ts +50 -0
  26. package/dist/api-sdk-v2/YfWifiSurveyApi.js +161 -0
  27. package/dist/db-sdk-v2/AddressDb.d.ts +2 -2
  28. package/dist/db-sdk-v2/AddressDb.js +6 -6
  29. package/dist/db-sdk-v2/ContactDb.d.ts +4 -4
  30. package/dist/db-sdk-v2/ContactDb.js +12 -12
  31. package/dist/db-sdk-v2/FileDb.d.ts +2 -0
  32. package/dist/db-sdk-v2/FileDb.js +6 -0
  33. package/dist/db-sdk-v2/WorkOrderDb.d.ts +2 -0
  34. package/dist/db-sdk-v2/WorkOrderDb.js +6 -0
  35. package/dist/db-sdk-v2/YfWifiSurveyDb.d.ts +122 -0
  36. package/dist/db-sdk-v2/YfWifiSurveyDb.js +210 -0
  37. package/dist/entities-v2/Address.d.ts +3 -3
  38. package/dist/entities-v2/Contact.d.ts +52 -46
  39. package/dist/entities-v2/Contact.js +26 -26
  40. package/dist/entities-v2/CustomerDeviceOnt.d.ts +7 -1
  41. package/dist/entities-v2/CustomerDeviceOnt.js +6 -0
  42. package/dist/entities-v2/File.d.ts +3 -0
  43. package/dist/entities-v2/Order.d.ts +7 -0
  44. package/dist/entities-v2/Order.js +2 -0
  45. package/dist/entities-v2/PaymentMethodRefund.d.ts +19 -0
  46. package/dist/entities-v2/PaymentMethodRefund.js +8 -0
  47. package/dist/entities-v2/WorkOrder.d.ts +7 -0
  48. package/dist/entities-v2/WorkOrder.js +5 -1
  49. package/dist/entities-v2/YfWifiSurvey.d.ts +164 -0
  50. package/dist/entities-v2/YfWifiSurvey.js +102 -0
  51. package/dist/records-v2/AddressRecord.d.ts +20 -20
  52. package/dist/records-v2/AddressRecord.js +33 -33
  53. package/dist/records-v2/CallRecord.d.ts +108 -0
  54. package/dist/records-v2/CallRecord.js +116 -0
  55. package/dist/records-v2/CaseRecord.d.ts +28 -0
  56. package/dist/records-v2/CaseRecord.js +37 -0
  57. package/dist/records-v2/ContactRecord.d.ts +26 -27
  58. package/dist/records-v2/ContactRecord.js +40 -48
  59. package/dist/records-v2/VisitRecord.d.ts +29 -0
  60. package/dist/records-v2/VisitRecord.js +36 -0
  61. package/package.json +3 -2
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 **802** actions.
368
+ This SDK includes **808** actions.
368
369
 
369
370
  ### Action Types
370
371
 
@@ -859,6 +860,7 @@ This SDK includes **802** 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 |
@@ -1356,6 +1358,8 @@ This SDK includes **802** actions.
1356
1358
  | `CreateInboundCall` | CREATE | k1.t-hEOJjsDb.NotificationModule.Call.Create.CreateInboundCall |
1357
1359
  | `CreateMissedIncomingCall` | CREATE | k1.t-hEOJjsDb.NotificationModule.Call.Create.CreateMissedIncomingCall |
1358
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 |
1359
1363
  | `UpdateCallAnalytics` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallAnalytics |
1360
1364
  | `UpdateCallInsights` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallInsights |
1361
1365
  | `UpdateCallOnCampaignDialAmdResult` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnCampaignDialAmdResult |
@@ -1367,7 +1371,9 @@ This SDK includes **802** actions.
1367
1371
  | `UpdateCallOnOutboundDialAction` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnOutboundDialAction |
1368
1372
  | `UpdateCallOnTaskRouterAssign` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallOnTaskRouterAssign |
1369
1373
  | `UpdateCallRecordingDetails` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallRecordingDetails |
1374
+ | `UpdateCallS3RecordingUrls` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallS3RecordingUrls |
1370
1375
  | `UpdateCallTranscriptionUrl` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallTranscriptionUrl |
1376
+ | `UpdateCampaignCallExternalId` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCampaignCallExternalId |
1371
1377
 
1372
1378
  #### Reward
1373
1379
 
@@ -2240,6 +2246,7 @@ This SDK includes **802** actions.
2240
2246
  | Action | Type | Event |
2241
2247
  |--------|------|-------|
2242
2248
  | `VisitCreate` | CREATE | k1.t-hEOJjsDb.CrmModule.Visit.Create.VisitCreate |
2249
+ | `VisitCreateSalesApp` | CREATE | k1.t-hEOJjsDb.CrmModule.Visit.Create.VisitCreateSalesApp |
2243
2250
  | `VisitUpdate` | UPDATE | k1.t-hEOJjsDb.CrmModule.Visit.Update.VisitUpdate |
2244
2251
 
2245
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;
@@ -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
@@ -0,0 +1,80 @@
1
+ /**
2
+ * UpdateCallS3RecordingUrls Action DTO
3
+ *
4
+ * Persists the S3 locations of a call recording once the upload from Twilio completes — the mono rendition and, when it was produced, the dual-channel rendition that AI transcription reads. Separate from UpdateCallRecordingDetails, which captures the Twilio-side Sid/Duration/Url at recording time and whose three required fields are not available here.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Call
8
+ * @actionKey UpdateCallS3RecordingUrls
9
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallS3RecordingUrls
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 UpdateCallS3RecordingUrls updated events
16
+ *
17
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallS3RecordingUrls
18
+ */
19
+ export interface UpdateCallS3RecordingUrlsMessage extends OdinRecordUpdatedEvent<UpdateCallS3RecordingUrlsDto, UpdateCallS3RecordingUrlsProperties> {
20
+ }
21
+ /**
22
+ * Properties for UpdateCallS3RecordingUrls action
23
+ *
24
+ * @property Required fields: 1
25
+ * @property Optional fields: 1
26
+ */
27
+ export interface UpdateCallS3RecordingUrlsProperties {
28
+ /**
29
+ * Recording URL (S3)
30
+ *
31
+ * RecordingUrl (Communications - Call)
32
+ * @type {TEXT}
33
+ * @required
34
+ */
35
+ RecordingUrl: string;
36
+ /**
37
+ * Dual-channel recording URL (S3)
38
+ *
39
+ * DualRecordingUrl
40
+ * @type {TEXT}
41
+ */
42
+ DualRecordingUrl?: string | null;
43
+ }
44
+ /**
45
+ * Store S3 recording URLs
46
+ *
47
+ * Persists the S3 locations of a call recording once the upload from Twilio completes — the mono rendition and, when it was produced, the dual-channel rendition that AI transcription reads. Separate from UpdateCallRecordingDetails, which captures the Twilio-side Sid/Duration/Url at recording time and whose three required fields are not available here.
48
+ *
49
+ * @actionType UPDATE - Updates an existing Call record
50
+ * @module NotificationModule
51
+ * @entity Call
52
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallS3RecordingUrls
53
+ * @permission schema.action.updatecalls3recordingurls.trigger
54
+ * @benchmark This action is tracked for performance benchmarks
55
+ */
56
+ export declare class UpdateCallS3RecordingUrlsDto extends OdinRecordUpdateDto<UpdateCallS3RecordingUrlsProperties> {
57
+ /** Used by SDK generators to identify action type */
58
+ static readonly ACTION_TYPE = "UPDATE";
59
+ static readonly ACTION_KEY = "UpdateCallS3RecordingUrls";
60
+ static readonly MODULE_NAME = "NotificationModule";
61
+ static readonly ENTITIES: string[];
62
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallS3RecordingUrls";
63
+ static readonly PERMISSION = "schema.action.updatecalls3recordingurls.trigger";
64
+ /** Step metadata - entity this action targets */
65
+ static readonly STEP_ENTITY = "NotificationModule:Call";
66
+ static readonly STEP_SCHEMA_ID = "e157f15c-6846-4bfb-bc92-aed4c4084e9f";
67
+ static readonly STEP_SCHEMA_ACTION_ID = "e9dbc287-877c-4277-bbe8-41ec083b8eee";
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: UpdateCallS3RecordingUrlsProperties, options?: {
77
+ journeyId?: string;
78
+ stageKey?: string;
79
+ });
80
+ }
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /**
3
+ * UpdateCallS3RecordingUrls Action DTO
4
+ *
5
+ * Persists the S3 locations of a call recording once the upload from Twilio completes — the mono rendition and, when it was produced, the dual-channel rendition that AI transcription reads. Separate from UpdateCallRecordingDetails, which captures the Twilio-side Sid/Duration/Url at recording time and whose three required fields are not available here.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Call
9
+ * @actionKey UpdateCallS3RecordingUrls
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallS3RecordingUrls
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.UpdateCallS3RecordingUrlsDto = void 0;
16
+ const core_1 = require("@d19n/odin-types/dist/core");
17
+ /**
18
+ * Store S3 recording URLs
19
+ *
20
+ * Persists the S3 locations of a call recording once the upload from Twilio completes — the mono rendition and, when it was produced, the dual-channel rendition that AI transcription reads. Separate from UpdateCallRecordingDetails, which captures the Twilio-side Sid/Duration/Url at recording time and whose three required fields are not available here.
21
+ *
22
+ * @actionType UPDATE - Updates an existing Call record
23
+ * @module NotificationModule
24
+ * @entity Call
25
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallS3RecordingUrls
26
+ * @permission schema.action.updatecalls3recordingurls.trigger
27
+ * @benchmark This action is tracked for performance benchmarks
28
+ */
29
+ class UpdateCallS3RecordingUrlsDto 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 = 'UpdateCallS3RecordingUrls';
40
+ this.schemaActionId = 'e9dbc287-877c-4277-bbe8-41ec083b8eee';
41
+ this.entity = 'NotificationModule:Call';
42
+ }
43
+ }
44
+ exports.UpdateCallS3RecordingUrlsDto = UpdateCallS3RecordingUrlsDto;
45
+ /** Used by SDK generators to identify action type */
46
+ UpdateCallS3RecordingUrlsDto.ACTION_TYPE = 'UPDATE';
47
+ UpdateCallS3RecordingUrlsDto.ACTION_KEY = 'UpdateCallS3RecordingUrls';
48
+ UpdateCallS3RecordingUrlsDto.MODULE_NAME = 'NotificationModule';
49
+ UpdateCallS3RecordingUrlsDto.ENTITIES = ['Call'];
50
+ UpdateCallS3RecordingUrlsDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCallS3RecordingUrls';
51
+ UpdateCallS3RecordingUrlsDto.PERMISSION = 'schema.action.updatecalls3recordingurls.trigger';
52
+ /** Step metadata - entity this action targets */
53
+ UpdateCallS3RecordingUrlsDto.STEP_ENTITY = 'NotificationModule:Call';
54
+ UpdateCallS3RecordingUrlsDto.STEP_SCHEMA_ID = 'e157f15c-6846-4bfb-bc92-aed4c4084e9f';
55
+ UpdateCallS3RecordingUrlsDto.STEP_SCHEMA_ACTION_ID = 'e9dbc287-877c-4277-bbe8-41ec083b8eee';
56
+ UpdateCallS3RecordingUrlsDto.AUTO_LINK_PARENT = false;
@@ -0,0 +1,73 @@
1
+ /**
2
+ * UpdateCampaignCallExternalId Action DTO
3
+ *
4
+ * Stamps the Twilio CallSid onto a campaign Call record after the outbound dial is placed. The Call is created before Twilio returns a Sid, so ExternalId is backfilled here — it is what every later webhook (AMD, call-status, recording) uses to find the record. ExternalId appears only on the four Call CREATE actions today; no update action carries it.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Call
8
+ * @actionKey UpdateCampaignCallExternalId
9
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCampaignCallExternalId
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 UpdateCampaignCallExternalId updated events
16
+ *
17
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCampaignCallExternalId
18
+ */
19
+ export interface UpdateCampaignCallExternalIdMessage extends OdinRecordUpdatedEvent<UpdateCampaignCallExternalIdDto, UpdateCampaignCallExternalIdProperties> {
20
+ }
21
+ /**
22
+ * Properties for UpdateCampaignCallExternalId action
23
+ *
24
+ * @property Required fields: 1
25
+ * @property Optional fields: 0
26
+ */
27
+ export interface UpdateCampaignCallExternalIdProperties {
28
+ /**
29
+ * Twilio CallSid
30
+ *
31
+ * the external id from the call management system (Communications - Call)
32
+ * @type {TEXT}
33
+ * @required
34
+ */
35
+ ExternalId: string;
36
+ }
37
+ /**
38
+ * Record Twilio CallSid
39
+ *
40
+ * Stamps the Twilio CallSid onto a campaign Call record after the outbound dial is placed. The Call is created before Twilio returns a Sid, so ExternalId is backfilled here — it is what every later webhook (AMD, call-status, recording) uses to find the record. ExternalId appears only on the four Call CREATE actions today; no update action carries it.
41
+ *
42
+ * @actionType UPDATE - Updates an existing Call record
43
+ * @module NotificationModule
44
+ * @entity Call
45
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCampaignCallExternalId
46
+ * @permission schema.action.updatecampaigncallexternalid.trigger
47
+ * @benchmark This action is tracked for performance benchmarks
48
+ */
49
+ export declare class UpdateCampaignCallExternalIdDto extends OdinRecordUpdateDto<UpdateCampaignCallExternalIdProperties> {
50
+ /** Used by SDK generators to identify action type */
51
+ static readonly ACTION_TYPE = "UPDATE";
52
+ static readonly ACTION_KEY = "UpdateCampaignCallExternalId";
53
+ static readonly MODULE_NAME = "NotificationModule";
54
+ static readonly ENTITIES: string[];
55
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCampaignCallExternalId";
56
+ static readonly PERMISSION = "schema.action.updatecampaigncallexternalid.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 = "c20904df-5ab8-4f92-a7c0-c0b7fad51fd8";
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: UpdateCampaignCallExternalIdProperties, options?: {
70
+ journeyId?: string;
71
+ stageKey?: string;
72
+ });
73
+ }
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /**
3
+ * UpdateCampaignCallExternalId Action DTO
4
+ *
5
+ * Stamps the Twilio CallSid onto a campaign Call record after the outbound dial is placed. The Call is created before Twilio returns a Sid, so ExternalId is backfilled here — it is what every later webhook (AMD, call-status, recording) uses to find the record. ExternalId appears only on the four Call CREATE actions today; no update action carries it.
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Call
9
+ * @actionKey UpdateCampaignCallExternalId
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCampaignCallExternalId
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.UpdateCampaignCallExternalIdDto = void 0;
16
+ const core_1 = require("@d19n/odin-types/dist/core");
17
+ /**
18
+ * Record Twilio CallSid
19
+ *
20
+ * Stamps the Twilio CallSid onto a campaign Call record after the outbound dial is placed. The Call is created before Twilio returns a Sid, so ExternalId is backfilled here — it is what every later webhook (AMD, call-status, recording) uses to find the record. ExternalId appears only on the four Call CREATE actions today; no update action carries it.
21
+ *
22
+ * @actionType UPDATE - Updates an existing Call record
23
+ * @module NotificationModule
24
+ * @entity Call
25
+ * @event k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCampaignCallExternalId
26
+ * @permission schema.action.updatecampaigncallexternalid.trigger
27
+ * @benchmark This action is tracked for performance benchmarks
28
+ */
29
+ class UpdateCampaignCallExternalIdDto 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 = 'UpdateCampaignCallExternalId';
40
+ this.schemaActionId = 'c20904df-5ab8-4f92-a7c0-c0b7fad51fd8';
41
+ this.entity = 'NotificationModule:Call';
42
+ }
43
+ }
44
+ exports.UpdateCampaignCallExternalIdDto = UpdateCampaignCallExternalIdDto;
45
+ /** Used by SDK generators to identify action type */
46
+ UpdateCampaignCallExternalIdDto.ACTION_TYPE = 'UPDATE';
47
+ UpdateCampaignCallExternalIdDto.ACTION_KEY = 'UpdateCampaignCallExternalId';
48
+ UpdateCampaignCallExternalIdDto.MODULE_NAME = 'NotificationModule';
49
+ UpdateCampaignCallExternalIdDto.ENTITIES = ['Call'];
50
+ UpdateCampaignCallExternalIdDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Call.Update.UpdateCampaignCallExternalId';
51
+ UpdateCampaignCallExternalIdDto.PERMISSION = 'schema.action.updatecampaigncallexternalid.trigger';
52
+ /** Step metadata - entity this action targets */
53
+ UpdateCampaignCallExternalIdDto.STEP_ENTITY = 'NotificationModule:Call';
54
+ UpdateCampaignCallExternalIdDto.STEP_SCHEMA_ID = 'e157f15c-6846-4bfb-bc92-aed4c4084e9f';
55
+ UpdateCampaignCallExternalIdDto.STEP_SCHEMA_ACTION_ID = 'c20904df-5ab8-4f92-a7c0-c0b7fad51fd8';
56
+ UpdateCampaignCallExternalIdDto.AUTO_LINK_PARENT = false;