@d19n/youfibre-odin-sdk 2.0.370 → 2.0.372

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 (54) hide show
  1. package/README.md +7 -3
  2. package/dist/actions-v2/CreateNoteForCaseSalesAppDto.d.ts +73 -0
  3. package/dist/actions-v2/CreateNoteForCaseSalesAppDto.js +59 -0
  4. package/dist/actions-v2/CreateOutboundDialCampaignDto.d.ts +8 -1
  5. package/dist/actions-v2/MoveCaseToSolvedWithNoteSalesAppDto.d.ts +171 -0
  6. package/dist/actions-v2/MoveCaseToSolvedWithNoteSalesAppDto.js +124 -0
  7. package/dist/actions-v2/OrderBuilderUpdateContactDto.d.ts +182 -0
  8. package/dist/actions-v2/OrderBuilderUpdateContactDto.js +56 -0
  9. package/dist/actions-v2/UpdateOutboundDialCampaignCaseDto.d.ts +15 -1
  10. package/dist/actions-v2/UpdateOutboundDialCampaignCaseOnDialEndDto.d.ts +15 -1
  11. package/dist/actions-v2/UpdateoutbounddialcampaignDto.d.ts +8 -1
  12. package/dist/api-sdk-v2/QaBatchApi.d.ts +48 -0
  13. package/dist/api-sdk-v2/QaBatchApi.js +155 -0
  14. package/dist/api-sdk-v2/QaReportApi.d.ts +2 -0
  15. package/dist/api-sdk-v2/QaReportApi.js +6 -0
  16. package/dist/db-sdk-v2/QaBatchDb.d.ts +120 -0
  17. package/dist/db-sdk-v2/QaBatchDb.js +204 -0
  18. package/dist/db-sdk-v2/QaReportDb.d.ts +2 -0
  19. package/dist/db-sdk-v2/QaReportDb.js +6 -0
  20. package/dist/entities-v2/AiRouteRequest.d.ts +2 -0
  21. package/dist/entities-v2/AiRouteRequest.js +2 -0
  22. package/dist/entities-v2/Document.d.ts +821 -12
  23. package/dist/entities-v2/Document.js +63 -1
  24. package/dist/entities-v2/DocumentProcessing.d.ts +7 -1
  25. package/dist/entities-v2/DocumentProcessing.js +6 -0
  26. package/dist/entities-v2/EquipmentReturnItem.d.ts +6 -6
  27. package/dist/entities-v2/EquipmentReturnItem.js +6 -6
  28. package/dist/entities-v2/HomeMove.d.ts +23 -1
  29. package/dist/entities-v2/HomeMove.js +17 -1
  30. package/dist/entities-v2/Note.d.ts +9 -9
  31. package/dist/entities-v2/Note.js +2 -2
  32. package/dist/entities-v2/Order.d.ts +9 -1
  33. package/dist/entities-v2/Order.js +2 -0
  34. package/dist/entities-v2/OutboundDialCampaign.d.ts +9 -1
  35. package/dist/entities-v2/OutboundDialCampaign.js +2 -0
  36. package/dist/entities-v2/OutboundDialCampaignCase.d.ts +17 -1
  37. package/dist/entities-v2/OutboundDialCampaignCase.js +4 -0
  38. package/dist/entities-v2/QaBatch.d.ts +235 -0
  39. package/dist/entities-v2/QaBatch.js +122 -0
  40. package/dist/entities-v2/QaReport.d.ts +12 -1
  41. package/dist/entities-v2/QaReport.js +2 -0
  42. package/dist/entities-v2/Recontract.d.ts +17 -1
  43. package/dist/entities-v2/Recontract.js +4 -0
  44. package/dist/entities-v2/Returns.d.ts +30 -30
  45. package/dist/entities-v2/Returns.js +30 -30
  46. package/dist/records-v2/CaseRecord.d.ts +87 -0
  47. package/dist/records-v2/CaseRecord.js +133 -1
  48. package/dist/records-v2/ContactRecord.d.ts +27 -0
  49. package/dist/records-v2/ContactRecord.js +29 -0
  50. package/dist/records-v2/DocumentRecord.d.ts +35 -3
  51. package/dist/records-v2/DocumentRecord.js +33 -1
  52. package/dist/records-v2/NoteRecord.d.ts +29 -0
  53. package/dist/records-v2/NoteRecord.js +36 -0
  54. package/package.json +1 -1
package/README.md CHANGED
@@ -124,7 +124,7 @@ await workOrder.completeWorkOrder({ ... });
124
124
 
125
125
  ## Entities
126
126
 
127
- This SDK includes **204** entities across **13** modules.
127
+ This SDK includes **205** entities across **13** modules.
128
128
 
129
129
  ### CrmModule
130
130
 
@@ -222,6 +222,7 @@ This SDK includes **204** entities across **13** modules.
222
222
  | **OutboundDialCampaignCase** | OutboundDialCampaignCase Entity Definition | DEFAULT |
223
223
  | **OutboundDialSession** | OutboundDialSession Entity Definition | DEFAULT |
224
224
  | **QaAutoFail** | QaAutoFail Entity Definition | DEFAULT |
225
+ | **QaBatch** | QaBatch Entity Definition | DEFAULT |
225
226
  | **QaEvaluation** | QaEvaluation Entity Definition | DEFAULT |
226
227
  | **QaEvaluationAnswer** | QaEvaluationAnswer Entity Definition | DEFAULT |
227
228
  | **QaReport** | QaReport Entity Definition | DEFAULT |
@@ -371,7 +372,7 @@ This SDK includes **204** entities across **13** modules.
371
372
 
372
373
  | Entity | Description | Types |
373
374
  |--------|-------------|-------|
374
- | **Document** | Document Entity Definition | CONTRACT_BUYOUT, EMAIL_ATTACHMENT, INVOICE... |
375
+ | **Document** | Document Entity Definition | CONTRACT, CONTRACT_BUYOUT, CORPORATE_DOCUMENT... |
375
376
  | **DocumentProcessing** | DocumentProcessing Entity Definition | DEFAULT |
376
377
 
377
378
  ### ProjectModule
@@ -397,7 +398,7 @@ This SDK includes **204** entities across **13** modules.
397
398
 
398
399
  ## Actions
399
400
 
400
- This SDK includes **932** actions.
401
+ This SDK includes **935** actions.
401
402
 
402
403
  ### Action Types
403
404
 
@@ -1270,6 +1271,8 @@ This SDK includes **932** actions.
1270
1271
  | `CaseCreateNote` | CREATE | k1.t-hEOJjsDb.SupportModule.Note.Create.CaseCreateNote |
1271
1272
  | `CreateNote` | CREATE | k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNote |
1272
1273
  | `CreateNoteForCaseAssignment` | CREATE | k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseAssignment |
1274
+ | `CreateNoteForCaseSalesApp` | CREATE | k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp |
1275
+ | `MoveCaseToSolvedWithNoteSalesApp` | CREATE | k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp |
1273
1276
  | `UpdateNote` | UPDATE | k1.t-hEOJjsDb.SupportModule.Note.Update.UpdateNote |
1274
1277
 
1275
1278
  #### PermissionToFail
@@ -1635,6 +1638,7 @@ This SDK includes **932** actions.
1635
1638
  |--------|------|-------|
1636
1639
  | `CreateContact` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContact |
1637
1640
  | `CreateContactSalesApp` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.CreateContactSalesApp |
1641
+ | `OrderBuilderUpdateContact` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact |
1638
1642
  | `UpdateAdditionalCare` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateAdditionalCare |
1639
1643
  | `UpdateContactAppPreferences` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateContactAppPreferences |
1640
1644
  | `UpdateContact` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateContact |
@@ -0,0 +1,73 @@
1
+ /**
2
+ * CreateNoteForCaseSalesApp Action DTO
3
+ *
4
+ * Sales App: a required note on a case, left when resolving it or returning it to a manager
5
+ *
6
+ * @module SupportModule
7
+ * @entity Note
8
+ * @entityType DEFAULT
9
+ * @actionKey CreateNoteForCaseSalesApp
10
+ * @event k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
15
+ /**
16
+ * RabbitMQ message payload for CreateNoteForCaseSalesApp created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp
19
+ */
20
+ export interface CreateNoteForCaseSalesAppMessage extends OdinRecordCreatedEvent<CreateNoteForCaseSalesAppDto, CreateNoteForCaseSalesAppProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateNoteForCaseSalesApp action
24
+ *
25
+ * @property Required fields: 1
26
+ * @property Optional fields: 0
27
+ */
28
+ export interface CreateNoteForCaseSalesAppProperties {
29
+ /**
30
+ * Add note
31
+ *
32
+ * body of the note (Customer Service - Note)
33
+ * @type {TEXT_LONG}
34
+ * @required
35
+ */
36
+ Body: string;
37
+ }
38
+ /**
39
+ * Add a note
40
+ *
41
+ * Sales App: a required note on a case, left when resolving it or returning it to a manager
42
+ *
43
+ * @actionType CREATE - Creates a new Note record
44
+ * @module SupportModule
45
+ * @entity Note
46
+ * @entityType DEFAULT (Default)
47
+ * @event k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp
48
+ * @permission schema.action.createnoteforcasesalesapp.trigger
49
+ * @benchmark This action is tracked for performance benchmarks
50
+ */
51
+ export declare class CreateNoteForCaseSalesAppDto extends OdinRecordCreateDto<CreateNoteForCaseSalesAppProperties> {
52
+ /** Used by SDK generators to identify action type */
53
+ static readonly ACTION_TYPE = "CREATE";
54
+ static readonly ACTION_KEY = "CreateNoteForCaseSalesApp";
55
+ static readonly MODULE_NAME = "SupportModule";
56
+ static readonly ENTITIES: string[];
57
+ static readonly ENTITY_TYPE = "DEFAULT";
58
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp";
59
+ static readonly PERMISSION = "schema.action.createnoteforcasesalesapp.trigger";
60
+ /** Step metadata - entity this action targets */
61
+ static readonly STEP_ENTITY = "SupportModule:Note";
62
+ static readonly STEP_SCHEMA_ID = "edce572c-c57f-4e29-ab99-7cf54001ebdf";
63
+ static readonly STEP_SCHEMA_ACTION_ID = "fe2e7406-1af7-42a2-815f-cfafe07113f3";
64
+ static readonly STEP_SCHEMA_TYPE_ID = "6b8ba290-25cd-4b73-a624-5005bed6afe6";
65
+ static readonly STEP_TYPE = "DEFAULT";
66
+ static readonly AUTO_LINK_PARENT = true;
67
+ readonly actionName: string;
68
+ readonly schemaActionId: string;
69
+ readonly entity: string;
70
+ constructor(properties: CreateNoteForCaseSalesAppProperties, options?: {
71
+ journeyId?: string;
72
+ });
73
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateNoteForCaseSalesApp Action DTO
4
+ *
5
+ * Sales App: a required note on a case, left when resolving it or returning it to a manager
6
+ *
7
+ * @module SupportModule
8
+ * @entity Note
9
+ * @entityType DEFAULT
10
+ * @actionKey CreateNoteForCaseSalesApp
11
+ * @event k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateNoteForCaseSalesAppDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * Add a note
20
+ *
21
+ * Sales App: a required note on a case, left when resolving it or returning it to a manager
22
+ *
23
+ * @actionType CREATE - Creates a new Note record
24
+ * @module SupportModule
25
+ * @entity Note
26
+ * @entityType DEFAULT (Default)
27
+ * @event k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp
28
+ * @permission schema.action.createnoteforcasesalesapp.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateNoteForCaseSalesAppDto extends core_1.OdinRecordCreateDto {
32
+ constructor(properties, options) {
33
+ super({
34
+ entity: 'SupportModule:Note',
35
+ type: 'DEFAULT',
36
+ properties,
37
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
38
+ });
39
+ this.actionName = 'CreateNoteForCaseSalesApp';
40
+ this.schemaActionId = 'fe2e7406-1af7-42a2-815f-cfafe07113f3';
41
+ this.entity = 'SupportModule:Note';
42
+ }
43
+ }
44
+ exports.CreateNoteForCaseSalesAppDto = CreateNoteForCaseSalesAppDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateNoteForCaseSalesAppDto.ACTION_TYPE = 'CREATE';
47
+ CreateNoteForCaseSalesAppDto.ACTION_KEY = 'CreateNoteForCaseSalesApp';
48
+ CreateNoteForCaseSalesAppDto.MODULE_NAME = 'SupportModule';
49
+ CreateNoteForCaseSalesAppDto.ENTITIES = ['Note'];
50
+ CreateNoteForCaseSalesAppDto.ENTITY_TYPE = 'DEFAULT';
51
+ CreateNoteForCaseSalesAppDto.EVENT_NAME = 'k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp';
52
+ CreateNoteForCaseSalesAppDto.PERMISSION = 'schema.action.createnoteforcasesalesapp.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateNoteForCaseSalesAppDto.STEP_ENTITY = 'SupportModule:Note';
55
+ CreateNoteForCaseSalesAppDto.STEP_SCHEMA_ID = 'edce572c-c57f-4e29-ab99-7cf54001ebdf';
56
+ CreateNoteForCaseSalesAppDto.STEP_SCHEMA_ACTION_ID = 'fe2e7406-1af7-42a2-815f-cfafe07113f3';
57
+ CreateNoteForCaseSalesAppDto.STEP_SCHEMA_TYPE_ID = '6b8ba290-25cd-4b73-a624-5005bed6afe6';
58
+ CreateNoteForCaseSalesAppDto.STEP_TYPE = 'DEFAULT';
59
+ CreateNoteForCaseSalesAppDto.AUTO_LINK_PARENT = true;
@@ -23,7 +23,7 @@ export interface CreateOutboundDialCampaignMessage extends OdinRecordCreatedEven
23
23
  * Properties for CreateOutboundDialCampaign action
24
24
  *
25
25
  * @property Required fields: 6
26
- * @property Optional fields: 2
26
+ * @property Optional fields: 3
27
27
  */
28
28
  export interface CreateOutboundDialCampaignProperties {
29
29
  /**
@@ -88,6 +88,13 @@ export interface CreateOutboundDialCampaignProperties {
88
88
  * @type {TEXT}
89
89
  */
90
90
  DistributionMode?: string | null;
91
+ /**
92
+ * RetentionCampaign
93
+ *
94
+ * When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false.
95
+ * @type {BOOLEAN}
96
+ */
97
+ RetentionCampaign?: boolean | null;
91
98
  }
92
99
  /**
93
100
  * CreateOutboundDialCampaign
@@ -0,0 +1,171 @@
1
+ /**
2
+ * MoveCaseToSolvedWithNoteSalesApp Action DTO
3
+ *
4
+ * Sales App: resolve a case — moves it to Solved with a required note
5
+ *
6
+ * @module SupportModule
7
+ * @entity Case
8
+ * @entityType DEFAULT
9
+ * @actionKey MoveCaseToSolvedWithNoteSalesApp
10
+ * @event k1.t-hEOJjsDb.SupportModule.Case.Transition.MoveCaseToSolvedWithNoteSalesApp
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ import { OdinRecord, OdinRecordCreateDto, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
15
+ /**
16
+ * Properties for CreateNoteForCaseSalesApp action
17
+ *
18
+ * @property Required fields: 1
19
+ * @property Optional fields: 0
20
+ */
21
+ export interface CreateNoteForCaseSalesAppProperties {
22
+ /**
23
+ * Add note
24
+ *
25
+ * body of the note (Customer Service - Note)
26
+ * @type {TEXT_LONG}
27
+ * @required
28
+ */
29
+ Body: string;
30
+ }
31
+ /**
32
+ * Add a note
33
+ *
34
+ * Sales App: a required note on a case, left when resolving it or returning it to a manager
35
+ *
36
+ * @actionType CREATE - Creates a new Note record
37
+ * @module SupportModule
38
+ * @entity Note
39
+ * @entityType DEFAULT (Default)
40
+ * @event k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp
41
+ * @permission schema.action.createnoteforcasesalesapp.trigger
42
+ * @benchmark This action is tracked for performance benchmarks
43
+ */
44
+ export declare class CreateNoteForCaseSalesAppDto extends OdinRecordCreateDto<CreateNoteForCaseSalesAppProperties> {
45
+ /** Used by SDK generators to identify action type */
46
+ static readonly ACTION_TYPE = "CREATE";
47
+ static readonly ACTION_KEY = "CreateNoteForCaseSalesApp";
48
+ static readonly MODULE_NAME = "SupportModule";
49
+ static readonly ENTITIES: string[];
50
+ static readonly ENTITY_TYPE = "DEFAULT";
51
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp";
52
+ static readonly PERMISSION = "schema.action.createnoteforcasesalesapp.trigger";
53
+ /** Step metadata - entity this action targets */
54
+ static readonly STEP_ENTITY = "SupportModule:Note";
55
+ static readonly STEP_SCHEMA_ID = "edce572c-c57f-4e29-ab99-7cf54001ebdf";
56
+ static readonly STEP_SCHEMA_ACTION_ID = "fe2e7406-1af7-42a2-815f-cfafe07113f3";
57
+ static readonly STEP_SCHEMA_TYPE_ID = "6b8ba290-25cd-4b73-a624-5005bed6afe6";
58
+ static readonly STEP_TYPE = "DEFAULT";
59
+ static readonly AUTO_LINK_PARENT = true;
60
+ readonly actionName: string;
61
+ readonly schemaActionId: string;
62
+ readonly entity: string;
63
+ constructor(properties: CreateNoteForCaseSalesAppProperties, options?: {
64
+ journeyId?: string;
65
+ });
66
+ }
67
+ declare type StepClassMap = {
68
+ CreateNoteForCaseSalesAppDto: CreateNoteForCaseSalesAppDto;
69
+ };
70
+ /**
71
+ * Link definition for connecting steps in MoveCaseToSolvedWithNoteSalesApp
72
+ */
73
+ export interface MoveCaseToSolvedWithNoteSalesAppStepLink {
74
+ /**
75
+ * The stepKey of the target step to link TO
76
+ * Must reference another step's stepKey in the same flow
77
+ */
78
+ stepKey: string;
79
+ /**
80
+ * The schema association ID (UUID) defining the relationship
81
+ * Use the association.id from the schema association definition
82
+ * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
83
+ */
84
+ schemaAssociationId: string;
85
+ }
86
+ /**
87
+ * Step definition with linking metadata for MoveCaseToSolvedWithNoteSalesApp
88
+ */
89
+ export interface MoveCaseToSolvedWithNoteSalesAppStepDefinition {
90
+ /** Unique identifier for this step */
91
+ stepKey: string;
92
+ /** The DTO class name for this step */
93
+ dtoClass: string;
94
+ /** The entity this step creates (Module:Entity format) */
95
+ entity: string;
96
+ /** Links to create after this step executes */
97
+ linksTo: MoveCaseToSolvedWithNoteSalesAppStepLink[] | null;
98
+ }
99
+ /**
100
+ * Type-safe step keys for MoveCaseToSolvedWithNoteSalesApp
101
+ */
102
+ export declare const MoveCaseToSolvedWithNoteSalesAppSteps: {
103
+ readonly add_a_note: "add_a_note";
104
+ };
105
+ export declare type MoveCaseToSolvedWithNoteSalesAppStepKey = typeof MoveCaseToSolvedWithNoteSalesAppSteps[keyof typeof MoveCaseToSolvedWithNoteSalesAppSteps];
106
+ /**
107
+ * RabbitMQ message payload for MoveCaseToSolvedWithNoteSalesApp step flow events
108
+ *
109
+ * @event k1.t-hEOJjsDb.SupportModule.Case.Transition.MoveCaseToSolvedWithNoteSalesApp
110
+ */
111
+ export interface MoveCaseToSolvedWithNoteSalesAppMessage extends OdinRecordUpdatedEvent<MoveCaseToSolvedWithNoteSalesAppDto, {}> {
112
+ }
113
+ /**
114
+ * Properties for MoveCaseToSolvedWithNoteSalesApp action
115
+ *
116
+ */
117
+ export interface MoveCaseToSolvedWithNoteSalesAppProperties {
118
+ }
119
+ /**
120
+ * Resolve
121
+ *
122
+ * Sales App: resolve a case — moves it to Solved with a required note
123
+ *
124
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
125
+ * @module SupportModule
126
+ * @entity Case
127
+ * @entityType DEFAULT (Default)
128
+ * @targetStages CaseDefaultStageSolved
129
+ * @event k1.t-hEOJjsDb.SupportModule.Case.Transition.MoveCaseToSolvedWithNoteSalesApp
130
+ * @permission schema.action.movecasetosolvedwithnotesalesapp.trigger
131
+ * @benchmark This action is tracked for performance benchmarks
132
+ */
133
+ export declare class MoveCaseToSolvedWithNoteSalesAppDto extends OdinRecordUpdateDto<Record<string, any>> {
134
+ /** Used by SDK generators to identify action type */
135
+ static readonly ACTION_TYPE = "UPDATE";
136
+ static readonly ACTION_KEY = "MoveCaseToSolvedWithNoteSalesApp";
137
+ static readonly MODULE_NAME = "SupportModule";
138
+ static readonly ENTITIES: string[];
139
+ static readonly ENTITY_TYPE = "DEFAULT";
140
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.SupportModule.Case.Transition.MoveCaseToSolvedWithNoteSalesApp";
141
+ static readonly SCHEMA_ACTION_ID = "b0255753-618d-40c7-9293-4f52dbf672d4";
142
+ static readonly PERMISSION = "schema.action.movecasetosolvedwithnotesalesapp.trigger";
143
+ static readonly TARGET_STAGES: readonly ["CaseDefaultStageSolved"];
144
+ static readonly IS_STAGE_TRANSITION = true;
145
+ static readonly IS_MULTI_STEP_FLOW = false;
146
+ static readonly HAS_STEP_LINKS = false;
147
+ /**
148
+ * Step definitions with linking metadata
149
+ * Used by SDK and backend for auto-linking after step execution
150
+ */
151
+ static readonly stepDefinitions: MoveCaseToSolvedWithNoteSalesAppStepDefinition[];
152
+ /** Type-safe step key accessor */
153
+ static readonly Steps: {
154
+ readonly add_a_note: "add_a_note";
155
+ };
156
+ readonly actionName: string;
157
+ readonly schemaActionId: string;
158
+ readonly entity: string;
159
+ readonly stageKey: string;
160
+ constructor(record: OdinRecord<any> | {
161
+ id: string;
162
+ entity: string;
163
+ type?: string;
164
+ }, options?: {
165
+ journeyId?: string;
166
+ });
167
+ /** Step classes that can be used with this action */
168
+ static readonly stepClasses: readonly ["CreateNoteForCaseSalesAppDto"];
169
+ steps: StepClassMap[(typeof MoveCaseToSolvedWithNoteSalesAppDto.stepClasses)[number]][];
170
+ }
171
+ export {};
@@ -0,0 +1,124 @@
1
+ "use strict";
2
+ /**
3
+ * MoveCaseToSolvedWithNoteSalesApp Action DTO
4
+ *
5
+ * Sales App: resolve a case — moves it to Solved with a required note
6
+ *
7
+ * @module SupportModule
8
+ * @entity Case
9
+ * @entityType DEFAULT
10
+ * @actionKey MoveCaseToSolvedWithNoteSalesApp
11
+ * @event k1.t-hEOJjsDb.SupportModule.Case.Transition.MoveCaseToSolvedWithNoteSalesApp
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.MoveCaseToSolvedWithNoteSalesAppDto = exports.MoveCaseToSolvedWithNoteSalesAppSteps = exports.CreateNoteForCaseSalesAppDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * Add a note
20
+ *
21
+ * Sales App: a required note on a case, left when resolving it or returning it to a manager
22
+ *
23
+ * @actionType CREATE - Creates a new Note record
24
+ * @module SupportModule
25
+ * @entity Note
26
+ * @entityType DEFAULT (Default)
27
+ * @event k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp
28
+ * @permission schema.action.createnoteforcasesalesapp.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateNoteForCaseSalesAppDto extends core_1.OdinRecordCreateDto {
32
+ constructor(properties, options) {
33
+ super({
34
+ entity: 'SupportModule:Note',
35
+ type: 'DEFAULT',
36
+ properties,
37
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
38
+ });
39
+ this.actionName = 'CreateNoteForCaseSalesApp';
40
+ this.schemaActionId = 'fe2e7406-1af7-42a2-815f-cfafe07113f3';
41
+ this.entity = 'SupportModule:Note';
42
+ }
43
+ }
44
+ exports.CreateNoteForCaseSalesAppDto = CreateNoteForCaseSalesAppDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateNoteForCaseSalesAppDto.ACTION_TYPE = 'CREATE';
47
+ CreateNoteForCaseSalesAppDto.ACTION_KEY = 'CreateNoteForCaseSalesApp';
48
+ CreateNoteForCaseSalesAppDto.MODULE_NAME = 'SupportModule';
49
+ CreateNoteForCaseSalesAppDto.ENTITIES = ['Note'];
50
+ CreateNoteForCaseSalesAppDto.ENTITY_TYPE = 'DEFAULT';
51
+ CreateNoteForCaseSalesAppDto.EVENT_NAME = 'k1.t-hEOJjsDb.SupportModule.Note.Create.CreateNoteForCaseSalesApp';
52
+ CreateNoteForCaseSalesAppDto.PERMISSION = 'schema.action.createnoteforcasesalesapp.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateNoteForCaseSalesAppDto.STEP_ENTITY = 'SupportModule:Note';
55
+ CreateNoteForCaseSalesAppDto.STEP_SCHEMA_ID = 'edce572c-c57f-4e29-ab99-7cf54001ebdf';
56
+ CreateNoteForCaseSalesAppDto.STEP_SCHEMA_ACTION_ID = 'fe2e7406-1af7-42a2-815f-cfafe07113f3';
57
+ CreateNoteForCaseSalesAppDto.STEP_SCHEMA_TYPE_ID = '6b8ba290-25cd-4b73-a624-5005bed6afe6';
58
+ CreateNoteForCaseSalesAppDto.STEP_TYPE = 'DEFAULT';
59
+ CreateNoteForCaseSalesAppDto.AUTO_LINK_PARENT = true;
60
+ /**
61
+ * Type-safe step keys for MoveCaseToSolvedWithNoteSalesApp
62
+ */
63
+ exports.MoveCaseToSolvedWithNoteSalesAppSteps = {
64
+ add_a_note: 'add_a_note',
65
+ };
66
+ /**
67
+ * Resolve
68
+ *
69
+ * Sales App: resolve a case — moves it to Solved with a required note
70
+ *
71
+ * @actionType STAGE_TRANSITION - Transitions record to new pipeline stage
72
+ * @module SupportModule
73
+ * @entity Case
74
+ * @entityType DEFAULT (Default)
75
+ * @targetStages CaseDefaultStageSolved
76
+ * @event k1.t-hEOJjsDb.SupportModule.Case.Transition.MoveCaseToSolvedWithNoteSalesApp
77
+ * @permission schema.action.movecasetosolvedwithnotesalesapp.trigger
78
+ * @benchmark This action is tracked for performance benchmarks
79
+ */
80
+ class MoveCaseToSolvedWithNoteSalesAppDto extends core_1.OdinRecordUpdateDto {
81
+ constructor(record, options) {
82
+ super({
83
+ id: record.id,
84
+ entity: record.entity,
85
+ type: record.type,
86
+ properties: {},
87
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
88
+ });
89
+ this.actionName = 'MoveCaseToSolvedWithNoteSalesApp';
90
+ this.schemaActionId = 'b0255753-618d-40c7-9293-4f52dbf672d4';
91
+ this.entity = 'SupportModule:Case';
92
+ this.stageKey = 'CaseDefaultStageSolved';
93
+ }
94
+ }
95
+ exports.MoveCaseToSolvedWithNoteSalesAppDto = MoveCaseToSolvedWithNoteSalesAppDto;
96
+ /** Used by SDK generators to identify action type */
97
+ MoveCaseToSolvedWithNoteSalesAppDto.ACTION_TYPE = 'UPDATE';
98
+ MoveCaseToSolvedWithNoteSalesAppDto.ACTION_KEY = 'MoveCaseToSolvedWithNoteSalesApp';
99
+ MoveCaseToSolvedWithNoteSalesAppDto.MODULE_NAME = 'SupportModule';
100
+ MoveCaseToSolvedWithNoteSalesAppDto.ENTITIES = ['Case'];
101
+ MoveCaseToSolvedWithNoteSalesAppDto.ENTITY_TYPE = 'DEFAULT';
102
+ MoveCaseToSolvedWithNoteSalesAppDto.EVENT_NAME = 'k1.t-hEOJjsDb.SupportModule.Case.Transition.MoveCaseToSolvedWithNoteSalesApp';
103
+ MoveCaseToSolvedWithNoteSalesAppDto.SCHEMA_ACTION_ID = 'b0255753-618d-40c7-9293-4f52dbf672d4';
104
+ MoveCaseToSolvedWithNoteSalesAppDto.PERMISSION = 'schema.action.movecasetosolvedwithnotesalesapp.trigger';
105
+ MoveCaseToSolvedWithNoteSalesAppDto.TARGET_STAGES = ['CaseDefaultStageSolved'];
106
+ MoveCaseToSolvedWithNoteSalesAppDto.IS_STAGE_TRANSITION = true;
107
+ MoveCaseToSolvedWithNoteSalesAppDto.IS_MULTI_STEP_FLOW = false;
108
+ MoveCaseToSolvedWithNoteSalesAppDto.HAS_STEP_LINKS = false;
109
+ /**
110
+ * Step definitions with linking metadata
111
+ * Used by SDK and backend for auto-linking after step execution
112
+ */
113
+ MoveCaseToSolvedWithNoteSalesAppDto.stepDefinitions = [
114
+ {
115
+ stepKey: 'add_a_note',
116
+ dtoClass: 'CreateNoteForCaseSalesAppDto',
117
+ entity: 'SupportModule:Note',
118
+ linksTo: null
119
+ }
120
+ ];
121
+ /** Type-safe step key accessor */
122
+ MoveCaseToSolvedWithNoteSalesAppDto.Steps = exports.MoveCaseToSolvedWithNoteSalesAppSteps;
123
+ /** Step classes that can be used with this action */
124
+ MoveCaseToSolvedWithNoteSalesAppDto.stepClasses = ['CreateNoteForCaseSalesAppDto'];
@@ -0,0 +1,182 @@
1
+ /**
2
+ * OrderBuilderUpdateContact Action DTO
3
+ *
4
+ * Updates an existing Contact from Order Builder V2 step 2. Loaded by name by the desktop builder and saved through CrmModule/v2.0/records/apply-action, so the fields an agent may change on an existing contact are set on this form rather than in React. A sibling of UpdateContact, which keeps serving the Contact detail view: this one is not the default form and is not a record-header button. Form copied from UpdateContact, Critical Dependencies section included. CORE-1493.
5
+ *
6
+ * @module CrmModule
7
+ * @entity Contact
8
+ * @actionKey OrderBuilderUpdateContact
9
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact
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 OrderBuilderUpdateContact updated events
16
+ *
17
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact
18
+ */
19
+ export interface OrderBuilderUpdateContactMessage extends OdinRecordUpdatedEvent<OrderBuilderUpdateContactDto, OrderBuilderUpdateContactProperties> {
20
+ }
21
+ /**
22
+ * Properties for OrderBuilderUpdateContact action
23
+ *
24
+ * @property Required fields: 3
25
+ * @property Optional fields: 14
26
+ */
27
+ export interface OrderBuilderUpdateContactProperties {
28
+ /**
29
+ * First Name
30
+ *
31
+ * Contacts First Name (Sales - Contact)
32
+ * @type {TEXT}
33
+ * @required
34
+ */
35
+ FirstName: string;
36
+ /**
37
+ * Email Address
38
+ *
39
+ * Contacts Email Address (Sales - Contact)
40
+ * @type {EMAIL}
41
+ * @required
42
+ */
43
+ EmailAddress: string;
44
+ /**
45
+ * Last Name
46
+ *
47
+ * Contacts Last Name (Sales - Contact)
48
+ * @type {TEXT}
49
+ * @required
50
+ */
51
+ LastName: string;
52
+ /**
53
+ * Account Status
54
+ *
55
+ * NONE if haven't started registering, INACTIVE if started registering but haven't finished yet, or ACTIVE if successfully registered (Sales - Contact)
56
+ * @type {ENUM}
57
+ */
58
+ AccountStatus?: string | null;
59
+ /**
60
+ * Phone
61
+ *
62
+ * Phone number (Sales - Contact)
63
+ * @type {PHONE_NUMBER_E164_GB}
64
+ */
65
+ Phone?: string | null;
66
+ /**
67
+ * Mobile
68
+ *
69
+ * Mobile phone (Sales - Contact)
70
+ * @type {TEXT}
71
+ */
72
+ Mobile?: string | null;
73
+ /**
74
+ * Referral Email
75
+ *
76
+ * referral email (Sales - Contact)
77
+ * @type {TEXT}
78
+ */
79
+ ReferralEmail?: string | null;
80
+ /**
81
+ * MarketingConsent
82
+ *
83
+ * I am happy to hear from YouFibre by email, WhatsApp and SMS about YouFibre’s broadband packages and any special offers. I am aware that I can opt-out at any time. For details on how we manage your data, please see our privacy policy.
84
+ * @type {BOOLEAN}
85
+ */
86
+ MarketingConsent?: boolean | null;
87
+ /**
88
+ * In Contract Until
89
+ *
90
+ * the date the customer is in contract with another provider (Sales - Contact)
91
+ * @type {DATE}
92
+ * @format DD/MM/YYYY
93
+ */
94
+ InContractUntil?: string | null;
95
+ /**
96
+ * Previous Provider
97
+ *
98
+ * previous/current provider (Sales - Contact)
99
+ * @type {ENUM}
100
+ */
101
+ PreviousProvider?: string | null;
102
+ /**
103
+ * Current Contract Type
104
+ *
105
+ * current contract type (Sales - Contact)
106
+ * @type {TEXT}
107
+ */
108
+ CurrentContractType?: string | null;
109
+ /**
110
+ * Are you medically dependent on your broadband?
111
+ *
112
+ * Is the customer medically dependant on their broadband (Sales - Contact)
113
+ * @type {ENUM}
114
+ */
115
+ MedicallyDependant?: string | null;
116
+ /**
117
+ * Do any members of your household rely on a Telecare Alarm?
118
+ *
119
+ * Does the customer use a Telecare Alarm (Sales - Contact)
120
+ * @type {ENUM}
121
+ */
122
+ TelecareAlarm?: string | null;
123
+ /**
124
+ * Additional care requirements?
125
+ *
126
+ * Select a care requirement
127
+ * @type {ENUM_MULTI_SELECT}
128
+ */
129
+ AdditionalCareReason?: string | null;
130
+ /**
131
+ * Additional care notes
132
+ *
133
+ * Any additional information
134
+ * @type {TEXT_LONG}
135
+ */
136
+ AdditionalCareNotes?: string | null;
137
+ /**
138
+ * Additional Care Consent
139
+ *
140
+ * Customer consent for recording additional care requirements (Sales - Contact)
141
+ * @type {BOOLEAN}
142
+ * @requiredWhen MedicallyDependant = ["YES"] AND TelecareAlarm = ["YES"]
143
+ */
144
+ AdditionalCareConsent?: boolean | null;
145
+ }
146
+ /**
147
+ * OrderBuilderUpdateContact
148
+ *
149
+ * Updates an existing Contact from Order Builder V2 step 2. Loaded by name by the desktop builder and saved through CrmModule/v2.0/records/apply-action, so the fields an agent may change on an existing contact are set on this form rather than in React. A sibling of UpdateContact, which keeps serving the Contact detail view: this one is not the default form and is not a record-header button. Form copied from UpdateContact, Critical Dependencies section included. CORE-1493.
150
+ *
151
+ * @actionType UPDATE - Updates an existing Contact record
152
+ * @module CrmModule
153
+ * @entity Contact
154
+ * @event k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact
155
+ * @permission schema.action.orderbuilderupdatecontact.trigger
156
+ * @benchmark This action is tracked for performance benchmarks
157
+ */
158
+ export declare class OrderBuilderUpdateContactDto extends OdinRecordUpdateDto<OrderBuilderUpdateContactProperties> {
159
+ /** Used by SDK generators to identify action type */
160
+ static readonly ACTION_TYPE = "UPDATE";
161
+ static readonly ACTION_KEY = "OrderBuilderUpdateContact";
162
+ static readonly MODULE_NAME = "CrmModule";
163
+ static readonly ENTITIES: string[];
164
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.CrmModule.Contact.Update.OrderBuilderUpdateContact";
165
+ static readonly PERMISSION = "schema.action.orderbuilderupdatecontact.trigger";
166
+ /** Step metadata - entity this action targets */
167
+ static readonly STEP_ENTITY = "CrmModule:Contact";
168
+ static readonly STEP_SCHEMA_ID = "33643a0d-5b77-4895-a2da-991e0fd3432f";
169
+ static readonly STEP_SCHEMA_ACTION_ID = "4466e908-e22c-4980-8523-9a18492ab692";
170
+ static readonly AUTO_LINK_PARENT = false;
171
+ readonly actionName: string;
172
+ readonly schemaActionId: string;
173
+ readonly entity: string;
174
+ constructor(record: OdinRecord<any> | {
175
+ id: string;
176
+ entity: string;
177
+ type?: string;
178
+ }, properties: OrderBuilderUpdateContactProperties, options?: {
179
+ journeyId?: string;
180
+ stageKey?: string;
181
+ });
182
+ }