@d19n/youfibre-odin-sdk 2.0.336 → 2.0.338
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/dist/actions-v2/CreateCollectionAmcoWorkOrderDto.d.ts +1 -1
- package/dist/actions-v2/CreateCollectionAmcoWorkOrderFromOrderDto.d.ts +1 -1
- package/dist/actions-v2/CreateDispatchAmcoWorkOrderDto.d.ts +1 -1
- package/dist/actions-v2/CreateDispatchAmcoWorkOrderFromOrderDto.d.ts +1 -1
- package/dist/actions-v2/CreateInstallDayBeforeWifiEducationDto.d.ts +135 -0
- package/dist/actions-v2/CreateInstallDayBeforeWifiEducationDto.js +59 -0
- package/dist/actions-v2/CreateLeadSalesAppDto.d.ts +2 -2
- package/dist/entities-v2/QaReport.d.ts +41 -1
- package/dist/entities-v2/QaReport.js +10 -0
- package/dist/entities-v2/WorkOrder.d.ts +23 -19
- package/dist/entities-v2/WorkOrder.js +6 -2
- package/dist/records-v2/EmailRecord.d.ts +29 -0
- package/dist/records-v2/EmailRecord.js +36 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -379,7 +379,7 @@ This SDK includes **191** entities across **12** modules.
|
|
|
379
379
|
|
|
380
380
|
## Actions
|
|
381
381
|
|
|
382
|
-
This SDK includes **
|
|
382
|
+
This SDK includes **896** actions.
|
|
383
383
|
|
|
384
384
|
### Action Types
|
|
385
385
|
|
|
@@ -1418,6 +1418,7 @@ This SDK includes **895** actions.
|
|
|
1418
1418
|
| `CreateFailedInvoicePayment` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateFailedInvoicePayment |
|
|
1419
1419
|
| `CreateGenericRemediationRequired` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateGenericRemediationRequired |
|
|
1420
1420
|
| `CreateInboundSupportEmail` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateInboundSupportEmail |
|
|
1421
|
+
| `CreateInstallDayBeforeWifiEducation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation |
|
|
1421
1422
|
| `CreateNewCreditNote` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateNewCreditNote |
|
|
1422
1423
|
| `CreateNewInvoice` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateNewInvoice |
|
|
1423
1424
|
| `CreateOrderConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderConfirmation |
|
|
@@ -87,7 +87,7 @@ export interface CreateCollectionAmcoWorkOrderProperties {
|
|
|
87
87
|
/**
|
|
88
88
|
* Source
|
|
89
89
|
*
|
|
90
|
-
*
|
|
90
|
+
* Source of WO creation
|
|
91
91
|
* @type {ENUM}
|
|
92
92
|
*/
|
|
93
93
|
Source?: string | null;
|
|
@@ -79,7 +79,7 @@ export interface CreateCollectionAmcoWorkOrderProperties {
|
|
|
79
79
|
/**
|
|
80
80
|
* Source
|
|
81
81
|
*
|
|
82
|
-
*
|
|
82
|
+
* Source of WO creation
|
|
83
83
|
* @type {ENUM}
|
|
84
84
|
*/
|
|
85
85
|
Source?: string | null;
|
|
@@ -80,7 +80,7 @@ export interface CreateDispatchAmcoWorkOrderProperties {
|
|
|
80
80
|
/**
|
|
81
81
|
* Source
|
|
82
82
|
*
|
|
83
|
-
*
|
|
83
|
+
* Source of WO creation
|
|
84
84
|
* @type {ENUM}
|
|
85
85
|
*/
|
|
86
86
|
Source?: string | null;
|
|
@@ -72,7 +72,7 @@ export interface CreateDispatchAmcoWorkOrderProperties {
|
|
|
72
72
|
/**
|
|
73
73
|
* Source
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
* Source of WO creation
|
|
76
76
|
* @type {ENUM}
|
|
77
77
|
*/
|
|
78
78
|
Source?: string | null;
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreateInstallDayBeforeWifiEducation Action DTO
|
|
3
|
+
*
|
|
4
|
+
* Create install day-before Wi-Fi education email
|
|
5
|
+
*
|
|
6
|
+
* @module NotificationModule
|
|
7
|
+
* @entity Email
|
|
8
|
+
* @entityType TRANSACTIONAL
|
|
9
|
+
* @actionKey CreateInstallDayBeforeWifiEducation
|
|
10
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation
|
|
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 CreateInstallDayBeforeWifiEducation created events
|
|
17
|
+
*
|
|
18
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateInstallDayBeforeWifiEducationMessage extends OdinRecordCreatedEvent<CreateInstallDayBeforeWifiEducationDto, CreateInstallDayBeforeWifiEducationProperties> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Properties for CreateInstallDayBeforeWifiEducation action
|
|
24
|
+
*
|
|
25
|
+
* @property Required fields: 0
|
|
26
|
+
* @property Optional fields: 10
|
|
27
|
+
*/
|
|
28
|
+
export interface CreateInstallDayBeforeWifiEducationProperties {
|
|
29
|
+
/**
|
|
30
|
+
* Date
|
|
31
|
+
*
|
|
32
|
+
* Date field for Email records. Used by Communications team.
|
|
33
|
+
* @type {DATE_TIME}
|
|
34
|
+
*/
|
|
35
|
+
Date?: string | null;
|
|
36
|
+
/**
|
|
37
|
+
* EmailingService
|
|
38
|
+
*
|
|
39
|
+
* The provider we use to send email (eg. Sendgrid)
|
|
40
|
+
* @type {ENUM}
|
|
41
|
+
*/
|
|
42
|
+
EmailingService?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* ContactId
|
|
45
|
+
*
|
|
46
|
+
* The related Contact to send the email
|
|
47
|
+
* @type {LOOKUP}
|
|
48
|
+
*/
|
|
49
|
+
ContactId?: string | null;
|
|
50
|
+
/**
|
|
51
|
+
* TemplateLabel
|
|
52
|
+
*
|
|
53
|
+
* The template label from email templates engine
|
|
54
|
+
* @type {TEXT}
|
|
55
|
+
*/
|
|
56
|
+
TemplateLabel?: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* MessageId
|
|
59
|
+
*
|
|
60
|
+
* SMTP Message Id (Communications - Email)
|
|
61
|
+
* @type {TEXT}
|
|
62
|
+
*/
|
|
63
|
+
MessageId?: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* EmailSenderId
|
|
66
|
+
*
|
|
67
|
+
* The Email Sender related entity
|
|
68
|
+
* @type {LOOKUP}
|
|
69
|
+
*/
|
|
70
|
+
EmailSenderId?: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* DynamicData
|
|
73
|
+
*
|
|
74
|
+
* Data will pass to emailing service (variables)
|
|
75
|
+
* @type {JSON}
|
|
76
|
+
*/
|
|
77
|
+
DynamicData?: string | null;
|
|
78
|
+
/**
|
|
79
|
+
* Title
|
|
80
|
+
*
|
|
81
|
+
* Used for title
|
|
82
|
+
* @type {TEXT}
|
|
83
|
+
*/
|
|
84
|
+
Title?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Subject
|
|
87
|
+
*
|
|
88
|
+
* Data field for Email records. Used by Communications team.
|
|
89
|
+
* @type {TEXT}
|
|
90
|
+
*/
|
|
91
|
+
Subject?: string | null;
|
|
92
|
+
/**
|
|
93
|
+
* To
|
|
94
|
+
*
|
|
95
|
+
* Data field for Email records. Used by Communications team.
|
|
96
|
+
* @type {TEXT}
|
|
97
|
+
*/
|
|
98
|
+
To?: string | null;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* CreateInstallDayBeforeWifiEducation
|
|
102
|
+
*
|
|
103
|
+
* Create install day-before Wi-Fi education email
|
|
104
|
+
*
|
|
105
|
+
* @actionType CREATE - Creates a new Email record
|
|
106
|
+
* @module NotificationModule
|
|
107
|
+
* @entity Email
|
|
108
|
+
* @entityType TRANSACTIONAL (TRANSACTIONAL)
|
|
109
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation
|
|
110
|
+
* @permission schema.action.createinstalldaybeforewifieducation.trigger
|
|
111
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
112
|
+
*/
|
|
113
|
+
export declare class CreateInstallDayBeforeWifiEducationDto extends OdinRecordCreateDto<CreateInstallDayBeforeWifiEducationProperties> {
|
|
114
|
+
/** Used by SDK generators to identify action type */
|
|
115
|
+
static readonly ACTION_TYPE = "CREATE";
|
|
116
|
+
static readonly ACTION_KEY = "CreateInstallDayBeforeWifiEducation";
|
|
117
|
+
static readonly MODULE_NAME = "NotificationModule";
|
|
118
|
+
static readonly ENTITIES: string[];
|
|
119
|
+
static readonly ENTITY_TYPE = "TRANSACTIONAL";
|
|
120
|
+
static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation";
|
|
121
|
+
static readonly PERMISSION = "schema.action.createinstalldaybeforewifieducation.trigger";
|
|
122
|
+
/** Step metadata - entity this action targets */
|
|
123
|
+
static readonly STEP_ENTITY = "NotificationModule:Email";
|
|
124
|
+
static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
|
|
125
|
+
static readonly STEP_SCHEMA_ACTION_ID = "c4f9cf49-bd6d-4998-b78d-2c39a2c3cfe8";
|
|
126
|
+
static readonly STEP_SCHEMA_TYPE_ID = "14042940-a388-44c7-87fe-3a4105d92e94";
|
|
127
|
+
static readonly STEP_TYPE = "TRANSACTIONAL";
|
|
128
|
+
static readonly AUTO_LINK_PARENT = true;
|
|
129
|
+
readonly actionName: string;
|
|
130
|
+
readonly schemaActionId: string;
|
|
131
|
+
readonly entity: string;
|
|
132
|
+
constructor(properties: CreateInstallDayBeforeWifiEducationProperties, options?: {
|
|
133
|
+
journeyId?: string;
|
|
134
|
+
});
|
|
135
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* CreateInstallDayBeforeWifiEducation Action DTO
|
|
4
|
+
*
|
|
5
|
+
* Create install day-before Wi-Fi education email
|
|
6
|
+
*
|
|
7
|
+
* @module NotificationModule
|
|
8
|
+
* @entity Email
|
|
9
|
+
* @entityType TRANSACTIONAL
|
|
10
|
+
* @actionKey CreateInstallDayBeforeWifiEducation
|
|
11
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation
|
|
12
|
+
*
|
|
13
|
+
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.CreateInstallDayBeforeWifiEducationDto = void 0;
|
|
17
|
+
const core_1 = require("@d19n/odin-types/dist/core");
|
|
18
|
+
/**
|
|
19
|
+
* CreateInstallDayBeforeWifiEducation
|
|
20
|
+
*
|
|
21
|
+
* Create install day-before Wi-Fi education email
|
|
22
|
+
*
|
|
23
|
+
* @actionType CREATE - Creates a new Email record
|
|
24
|
+
* @module NotificationModule
|
|
25
|
+
* @entity Email
|
|
26
|
+
* @entityType TRANSACTIONAL (TRANSACTIONAL)
|
|
27
|
+
* @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation
|
|
28
|
+
* @permission schema.action.createinstalldaybeforewifieducation.trigger
|
|
29
|
+
* @benchmark This action is tracked for performance benchmarks
|
|
30
|
+
*/
|
|
31
|
+
class CreateInstallDayBeforeWifiEducationDto extends core_1.OdinRecordCreateDto {
|
|
32
|
+
constructor(properties, options) {
|
|
33
|
+
super({
|
|
34
|
+
entity: 'NotificationModule:Email',
|
|
35
|
+
type: 'TRANSACTIONAL',
|
|
36
|
+
properties,
|
|
37
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
38
|
+
});
|
|
39
|
+
this.actionName = 'CreateInstallDayBeforeWifiEducation';
|
|
40
|
+
this.schemaActionId = 'c4f9cf49-bd6d-4998-b78d-2c39a2c3cfe8';
|
|
41
|
+
this.entity = 'NotificationModule:Email';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
exports.CreateInstallDayBeforeWifiEducationDto = CreateInstallDayBeforeWifiEducationDto;
|
|
45
|
+
/** Used by SDK generators to identify action type */
|
|
46
|
+
CreateInstallDayBeforeWifiEducationDto.ACTION_TYPE = 'CREATE';
|
|
47
|
+
CreateInstallDayBeforeWifiEducationDto.ACTION_KEY = 'CreateInstallDayBeforeWifiEducation';
|
|
48
|
+
CreateInstallDayBeforeWifiEducationDto.MODULE_NAME = 'NotificationModule';
|
|
49
|
+
CreateInstallDayBeforeWifiEducationDto.ENTITIES = ['Email'];
|
|
50
|
+
CreateInstallDayBeforeWifiEducationDto.ENTITY_TYPE = 'TRANSACTIONAL';
|
|
51
|
+
CreateInstallDayBeforeWifiEducationDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation';
|
|
52
|
+
CreateInstallDayBeforeWifiEducationDto.PERMISSION = 'schema.action.createinstalldaybeforewifieducation.trigger';
|
|
53
|
+
/** Step metadata - entity this action targets */
|
|
54
|
+
CreateInstallDayBeforeWifiEducationDto.STEP_ENTITY = 'NotificationModule:Email';
|
|
55
|
+
CreateInstallDayBeforeWifiEducationDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
|
|
56
|
+
CreateInstallDayBeforeWifiEducationDto.STEP_SCHEMA_ACTION_ID = 'c4f9cf49-bd6d-4998-b78d-2c39a2c3cfe8';
|
|
57
|
+
CreateInstallDayBeforeWifiEducationDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
|
|
58
|
+
CreateInstallDayBeforeWifiEducationDto.STEP_TYPE = 'TRANSACTIONAL';
|
|
59
|
+
CreateInstallDayBeforeWifiEducationDto.AUTO_LINK_PARENT = true;
|
|
@@ -26,7 +26,7 @@ export interface CreateLeadSalesAppMessage extends OdinRecordCreatedEvent<Create
|
|
|
26
26
|
*/
|
|
27
27
|
export interface CreateLeadSalesAppProperties {
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* First name
|
|
30
30
|
*
|
|
31
31
|
* Copy and paste address title please
|
|
32
32
|
* @type {TEXT}
|
|
@@ -34,7 +34,7 @@ export interface CreateLeadSalesAppProperties {
|
|
|
34
34
|
*/
|
|
35
35
|
Name: string;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* Nast name
|
|
38
38
|
*
|
|
39
39
|
* Display name/title for Lead records. Primary identifier for Sales team.
|
|
40
40
|
* @type {TEXT}
|
|
@@ -102,7 +102,17 @@ export declare enum QaReportPropertyKeys {
|
|
|
102
102
|
/** Free text from the person giving feedback. TEXT, not TEXT_LONG: the ceiling is the same either way, about 2,700 characters of varied text, which is far more than a comment needs. */
|
|
103
103
|
FeedbackComment = "FeedbackComment",
|
|
104
104
|
/** When the feedback was given. Separate from updatedAt, which moves on any change to the record. */
|
|
105
|
-
FeedbackAt = "FeedbackAt"
|
|
105
|
+
FeedbackAt = "FeedbackAt",
|
|
106
|
+
/** Record number of the QaRubric the report was scored against, e.g. QRB2. Empty when the Databricks prompt's built-in rubric was used. */
|
|
107
|
+
Rubric = "Rubric",
|
|
108
|
+
/** Version of that QaRubric at the time of scoring. */
|
|
109
|
+
RubricVersion = "RubricVersion",
|
|
110
|
+
/** SHA-256 of the exact scoring_criteria string sent to Databricks, confirmed by the model. Two reports with the same value were scored against identical criteria. */
|
|
111
|
+
RubricSha256 = "RubricSha256",
|
|
112
|
+
/** S3 URL of the exact scoring_criteria JSON sent with this report, so the criteria that produced the score can always be read back. */
|
|
113
|
+
RubricSnapshotUrl = "RubricSnapshotUrl",
|
|
114
|
+
/** S3 URL of qa_result: the verdict and points for every rubric item, the section totals and the score, all computed in code by the Databricks endpoint. Only set when the report was scored against an Odin rubric. Per-item analytics read this. */
|
|
115
|
+
QaResultUrl = "QaResultUrl"
|
|
106
116
|
}
|
|
107
117
|
/**
|
|
108
118
|
* Properties for QaReport records
|
|
@@ -198,6 +208,36 @@ export interface QaReportProperties {
|
|
|
198
208
|
* @default
|
|
199
209
|
*/
|
|
200
210
|
FeedbackAt: string;
|
|
211
|
+
/** Record number of the QaRubric the report was scored against, e.g. QRB2. Empty when the Databricks prompt's built-in rubric was used.
|
|
212
|
+
*
|
|
213
|
+
* @type {TEXT}
|
|
214
|
+
* @default
|
|
215
|
+
*/
|
|
216
|
+
Rubric: string;
|
|
217
|
+
/** Version of that QaRubric at the time of scoring.
|
|
218
|
+
*
|
|
219
|
+
* @type {NUMBER}
|
|
220
|
+
* @default
|
|
221
|
+
*/
|
|
222
|
+
RubricVersion: number;
|
|
223
|
+
/** SHA-256 of the exact scoring_criteria string sent to Databricks, confirmed by the model. Two reports with the same value were scored against identical criteria.
|
|
224
|
+
*
|
|
225
|
+
* @type {TEXT}
|
|
226
|
+
* @default
|
|
227
|
+
*/
|
|
228
|
+
RubricSha256: string;
|
|
229
|
+
/** S3 URL of the exact scoring_criteria JSON sent with this report, so the criteria that produced the score can always be read back.
|
|
230
|
+
*
|
|
231
|
+
* @type {TEXT}
|
|
232
|
+
* @default
|
|
233
|
+
*/
|
|
234
|
+
RubricSnapshotUrl: string;
|
|
235
|
+
/** S3 URL of qa_result: the verdict and points for every rubric item, the section totals and the score, all computed in code by the Databricks endpoint. Only set when the report was scored against an Odin rubric. Per-item analytics read this.
|
|
236
|
+
*
|
|
237
|
+
* @type {TEXT}
|
|
238
|
+
* @default
|
|
239
|
+
*/
|
|
240
|
+
QaResultUrl: string;
|
|
201
241
|
}
|
|
202
242
|
/**
|
|
203
243
|
* QaReport entity from SupportModule
|
|
@@ -110,6 +110,16 @@ var QaReportPropertyKeys;
|
|
|
110
110
|
QaReportPropertyKeys["FeedbackComment"] = "FeedbackComment";
|
|
111
111
|
/** When the feedback was given. Separate from updatedAt, which moves on any change to the record. */
|
|
112
112
|
QaReportPropertyKeys["FeedbackAt"] = "FeedbackAt";
|
|
113
|
+
/** Record number of the QaRubric the report was scored against, e.g. QRB2. Empty when the Databricks prompt's built-in rubric was used. */
|
|
114
|
+
QaReportPropertyKeys["Rubric"] = "Rubric";
|
|
115
|
+
/** Version of that QaRubric at the time of scoring. */
|
|
116
|
+
QaReportPropertyKeys["RubricVersion"] = "RubricVersion";
|
|
117
|
+
/** SHA-256 of the exact scoring_criteria string sent to Databricks, confirmed by the model. Two reports with the same value were scored against identical criteria. */
|
|
118
|
+
QaReportPropertyKeys["RubricSha256"] = "RubricSha256";
|
|
119
|
+
/** S3 URL of the exact scoring_criteria JSON sent with this report, so the criteria that produced the score can always be read back. */
|
|
120
|
+
QaReportPropertyKeys["RubricSnapshotUrl"] = "RubricSnapshotUrl";
|
|
121
|
+
/** S3 URL of qa_result: the verdict and points for every rubric item, the section totals and the score, all computed in code by the Databricks endpoint. Only set when the report was scored against an Odin rubric. Per-item analytics read this. */
|
|
122
|
+
QaReportPropertyKeys["QaResultUrl"] = "QaResultUrl";
|
|
113
123
|
})(QaReportPropertyKeys = exports.QaReportPropertyKeys || (exports.QaReportPropertyKeys = {}));
|
|
114
124
|
/**
|
|
115
125
|
* QaReport entity from SupportModule
|
|
@@ -1399,15 +1399,19 @@ export declare enum WorkOrderPreventableWorkOrder {
|
|
|
1399
1399
|
/**
|
|
1400
1400
|
* Valid values for WorkOrder.Source
|
|
1401
1401
|
*
|
|
1402
|
-
*
|
|
1402
|
+
* Source of WO creation
|
|
1403
1403
|
*
|
|
1404
1404
|
* @remarks Available options:
|
|
1405
|
+
* - `AGENT` - Agent
|
|
1405
1406
|
* - `CUSTOMER_APP` - Customer App
|
|
1406
1407
|
* - `CUSTOMER_PORTAL` - Customer Portal
|
|
1408
|
+
* - `ODIN_SYSTEM` - Odin System
|
|
1407
1409
|
*/
|
|
1408
1410
|
export declare enum WorkOrderSource {
|
|
1411
|
+
AGENT = "AGENT",
|
|
1409
1412
|
CUSTOMER_APP = "CUSTOMER_APP",
|
|
1410
|
-
CUSTOMER_PORTAL = "CUSTOMER_PORTAL"
|
|
1413
|
+
CUSTOMER_PORTAL = "CUSTOMER_PORTAL",
|
|
1414
|
+
ODIN_SYSTEM = "ODIN_SYSTEM"
|
|
1411
1415
|
}
|
|
1412
1416
|
/**
|
|
1413
1417
|
* Property keys for WorkOrder
|
|
@@ -1688,7 +1692,7 @@ export declare enum WorkOrderPropertyKeys {
|
|
|
1688
1692
|
EquipmentChargeBreakdown = "EquipmentChargeBreakdown",
|
|
1689
1693
|
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260). */
|
|
1690
1694
|
ReplacedDeviceIds = "ReplacedDeviceIds",
|
|
1691
|
-
/**
|
|
1695
|
+
/** Source of WO creation */
|
|
1692
1696
|
Source = "Source"
|
|
1693
1697
|
}
|
|
1694
1698
|
/**
|
|
@@ -2495,7 +2499,7 @@ export interface WorkOrderProperties {
|
|
|
2495
2499
|
* @default
|
|
2496
2500
|
*/
|
|
2497
2501
|
ReplacedDeviceIds: string;
|
|
2498
|
-
/**
|
|
2502
|
+
/** Source of WO creation
|
|
2499
2503
|
*
|
|
2500
2504
|
* @type {ENUM}
|
|
2501
2505
|
* @default
|
|
@@ -3307,7 +3311,7 @@ export interface CollectionWorkOrderProperties {
|
|
|
3307
3311
|
* @default
|
|
3308
3312
|
*/
|
|
3309
3313
|
ReplacedDeviceIds: string;
|
|
3310
|
-
/**
|
|
3314
|
+
/** Source of WO creation
|
|
3311
3315
|
*
|
|
3312
3316
|
* @type {ENUM}
|
|
3313
3317
|
* @default
|
|
@@ -4119,7 +4123,7 @@ export interface CollectionAmcoWorkOrderProperties {
|
|
|
4119
4123
|
* @default
|
|
4120
4124
|
*/
|
|
4121
4125
|
ReplacedDeviceIds: string;
|
|
4122
|
-
/**
|
|
4126
|
+
/** Source of WO creation
|
|
4123
4127
|
*
|
|
4124
4128
|
* @type {ENUM}
|
|
4125
4129
|
* @default
|
|
@@ -4931,7 +4935,7 @@ export interface DispatchAmcoWorkOrderProperties {
|
|
|
4931
4935
|
* @default
|
|
4932
4936
|
*/
|
|
4933
4937
|
ReplacedDeviceIds: string;
|
|
4934
|
-
/**
|
|
4938
|
+
/** Source of WO creation
|
|
4935
4939
|
*
|
|
4936
4940
|
* @type {ENUM}
|
|
4937
4941
|
* @default
|
|
@@ -5743,7 +5747,7 @@ export interface FinanceWorkOrderProperties {
|
|
|
5743
5747
|
* @default
|
|
5744
5748
|
*/
|
|
5745
5749
|
ReplacedDeviceIds: string;
|
|
5746
|
-
/**
|
|
5750
|
+
/** Source of WO creation
|
|
5747
5751
|
*
|
|
5748
5752
|
* @type {ENUM}
|
|
5749
5753
|
* @default
|
|
@@ -6555,7 +6559,7 @@ export interface InspectionWorkOrderProperties {
|
|
|
6555
6559
|
* @default
|
|
6556
6560
|
*/
|
|
6557
6561
|
ReplacedDeviceIds: string;
|
|
6558
|
-
/**
|
|
6562
|
+
/** Source of WO creation
|
|
6559
6563
|
*
|
|
6560
6564
|
* @type {ENUM}
|
|
6561
6565
|
* @default
|
|
@@ -7367,7 +7371,7 @@ export interface InstallWorkOrderProperties {
|
|
|
7367
7371
|
* @default
|
|
7368
7372
|
*/
|
|
7369
7373
|
ReplacedDeviceIds: string;
|
|
7370
|
-
/**
|
|
7374
|
+
/** Source of WO creation
|
|
7371
7375
|
*
|
|
7372
7376
|
* @type {ENUM}
|
|
7373
7377
|
* @default
|
|
@@ -8179,7 +8183,7 @@ export interface InstallBusinessWorkOrderProperties {
|
|
|
8179
8183
|
* @default
|
|
8180
8184
|
*/
|
|
8181
8185
|
ReplacedDeviceIds: string;
|
|
8182
|
-
/**
|
|
8186
|
+
/** Source of WO creation
|
|
8183
8187
|
*
|
|
8184
8188
|
* @type {ENUM}
|
|
8185
8189
|
* @default
|
|
@@ -8991,7 +8995,7 @@ export interface InstallServiceWorkOrderProperties {
|
|
|
8991
8995
|
* @default
|
|
8992
8996
|
*/
|
|
8993
8997
|
ReplacedDeviceIds: string;
|
|
8994
|
-
/**
|
|
8998
|
+
/** Source of WO creation
|
|
8995
8999
|
*
|
|
8996
9000
|
* @type {ENUM}
|
|
8997
9001
|
* @default
|
|
@@ -9803,7 +9807,7 @@ export interface NetworkAdjustmentWorkOrderProperties {
|
|
|
9803
9807
|
* @default
|
|
9804
9808
|
*/
|
|
9805
9809
|
ReplacedDeviceIds: string;
|
|
9806
|
-
/**
|
|
9810
|
+
/** Source of WO creation
|
|
9807
9811
|
*
|
|
9808
9812
|
* @type {ENUM}
|
|
9809
9813
|
* @default
|
|
@@ -10615,7 +10619,7 @@ export interface PlanningWorkOrderProperties {
|
|
|
10615
10619
|
* @default
|
|
10616
10620
|
*/
|
|
10617
10621
|
ReplacedDeviceIds: string;
|
|
10618
|
-
/**
|
|
10622
|
+
/** Source of WO creation
|
|
10619
10623
|
*
|
|
10620
10624
|
* @type {ENUM}
|
|
10621
10625
|
* @default
|
|
@@ -11427,7 +11431,7 @@ export interface PrePullWorkOrderProperties {
|
|
|
11427
11431
|
* @default
|
|
11428
11432
|
*/
|
|
11429
11433
|
ReplacedDeviceIds: string;
|
|
11430
|
-
/**
|
|
11434
|
+
/** Source of WO creation
|
|
11431
11435
|
*
|
|
11432
11436
|
* @type {ENUM}
|
|
11433
11437
|
* @default
|
|
@@ -12239,7 +12243,7 @@ export interface RemediationWorkOrderProperties {
|
|
|
12239
12243
|
* @default
|
|
12240
12244
|
*/
|
|
12241
12245
|
ReplacedDeviceIds: string;
|
|
12242
|
-
/**
|
|
12246
|
+
/** Source of WO creation
|
|
12243
12247
|
*
|
|
12244
12248
|
* @type {ENUM}
|
|
12245
12249
|
* @default
|
|
@@ -13051,7 +13055,7 @@ export interface ReplacementAmcoWorkOrderProperties {
|
|
|
13051
13055
|
* @default
|
|
13052
13056
|
*/
|
|
13053
13057
|
ReplacedDeviceIds: string;
|
|
13054
|
-
/**
|
|
13058
|
+
/** Source of WO creation
|
|
13055
13059
|
*
|
|
13056
13060
|
* @type {ENUM}
|
|
13057
13061
|
* @default
|
|
@@ -13863,7 +13867,7 @@ export interface ServiceWorkOrderProperties {
|
|
|
13863
13867
|
* @default
|
|
13864
13868
|
*/
|
|
13865
13869
|
ReplacedDeviceIds: string;
|
|
13866
|
-
/**
|
|
13870
|
+
/** Source of WO creation
|
|
13867
13871
|
*
|
|
13868
13872
|
* @type {ENUM}
|
|
13869
13873
|
* @default
|
|
@@ -14675,7 +14679,7 @@ export interface WayleaveWorkOrderProperties {
|
|
|
14675
14679
|
* @default
|
|
14676
14680
|
*/
|
|
14677
14681
|
ReplacedDeviceIds: string;
|
|
14678
|
-
/**
|
|
14682
|
+
/** Source of WO creation
|
|
14679
14683
|
*
|
|
14680
14684
|
* @type {ENUM}
|
|
14681
14685
|
* @default
|
|
@@ -1399,16 +1399,20 @@ var WorkOrderPreventableWorkOrder;
|
|
|
1399
1399
|
/**
|
|
1400
1400
|
* Valid values for WorkOrder.Source
|
|
1401
1401
|
*
|
|
1402
|
-
*
|
|
1402
|
+
* Source of WO creation
|
|
1403
1403
|
*
|
|
1404
1404
|
* @remarks Available options:
|
|
1405
|
+
* - `AGENT` - Agent
|
|
1405
1406
|
* - `CUSTOMER_APP` - Customer App
|
|
1406
1407
|
* - `CUSTOMER_PORTAL` - Customer Portal
|
|
1408
|
+
* - `ODIN_SYSTEM` - Odin System
|
|
1407
1409
|
*/
|
|
1408
1410
|
var WorkOrderSource;
|
|
1409
1411
|
(function (WorkOrderSource) {
|
|
1412
|
+
WorkOrderSource["AGENT"] = "AGENT";
|
|
1410
1413
|
WorkOrderSource["CUSTOMER_APP"] = "CUSTOMER_APP";
|
|
1411
1414
|
WorkOrderSource["CUSTOMER_PORTAL"] = "CUSTOMER_PORTAL";
|
|
1415
|
+
WorkOrderSource["ODIN_SYSTEM"] = "ODIN_SYSTEM";
|
|
1412
1416
|
})(WorkOrderSource = exports.WorkOrderSource || (exports.WorkOrderSource = {}));
|
|
1413
1417
|
/**
|
|
1414
1418
|
* Property keys for WorkOrder
|
|
@@ -1690,7 +1694,7 @@ var WorkOrderPropertyKeys;
|
|
|
1690
1694
|
WorkOrderPropertyKeys["EquipmentChargeBreakdown"] = "EquipmentChargeBreakdown";
|
|
1691
1695
|
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260). */
|
|
1692
1696
|
WorkOrderPropertyKeys["ReplacedDeviceIds"] = "ReplacedDeviceIds";
|
|
1693
|
-
/**
|
|
1697
|
+
/** Source of WO creation */
|
|
1694
1698
|
WorkOrderPropertyKeys["Source"] = "Source";
|
|
1695
1699
|
})(WorkOrderPropertyKeys = exports.WorkOrderPropertyKeys || (exports.WorkOrderPropertyKeys = {}));
|
|
1696
1700
|
/**
|
|
@@ -47,6 +47,7 @@ import { CreateCboEmailProperties } from '../actions-v2/CreateCboEmailDto';
|
|
|
47
47
|
import { CreateFailedInvoicePaymentProperties } from '../actions-v2/CreateFailedInvoicePaymentDto';
|
|
48
48
|
import { CreateGenericRemediationRequiredProperties } from '../actions-v2/CreateGenericRemediationRequiredDto';
|
|
49
49
|
import { CreateInboundSupportEmailProperties } from '../actions-v2/CreateInboundSupportEmailDto';
|
|
50
|
+
import { CreateInstallDayBeforeWifiEducationProperties } from '../actions-v2/CreateInstallDayBeforeWifiEducationDto';
|
|
50
51
|
import { CreateNewCreditNoteProperties } from '../actions-v2/CreateNewCreditNoteDto';
|
|
51
52
|
import { CreateNewInvoiceProperties } from '../actions-v2/CreateNewInvoiceDto';
|
|
52
53
|
import { CreateOrderConfirmationProperties } from '../actions-v2/CreateOrderConfirmationDto';
|
|
@@ -1095,6 +1096,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
|
|
|
1095
1096
|
journeyId?: string;
|
|
1096
1097
|
stageKey?: string;
|
|
1097
1098
|
}): ActionBuilder;
|
|
1099
|
+
/**
|
|
1100
|
+
* CreateInstallDayBeforeWifiEducation
|
|
1101
|
+
*
|
|
1102
|
+
* Creates a new Email record with the specified properties.
|
|
1103
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
1104
|
+
*
|
|
1105
|
+
* @remarks Record type: TRANSACTIONAL
|
|
1106
|
+
*
|
|
1107
|
+
* @param properties - The properties for the new record
|
|
1108
|
+
* @param options - Optional settings
|
|
1109
|
+
* @param options.journeyId - Associate with a journey
|
|
1110
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
1111
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
1112
|
+
*
|
|
1113
|
+
* @example
|
|
1114
|
+
* ```typescript
|
|
1115
|
+
* // Create with properties
|
|
1116
|
+
* const record = odinClient.emails.new();
|
|
1117
|
+
* await record.createInstallDayBeforeWifiEducation({ ... }).execute();
|
|
1118
|
+
*
|
|
1119
|
+
* // Dry run (for debugging)
|
|
1120
|
+
* const payload = record.createInstallDayBeforeWifiEducation({ ... }).dryRun();
|
|
1121
|
+
* ```
|
|
1122
|
+
*/
|
|
1123
|
+
createInstallDayBeforeWifiEducation(properties?: CreateInstallDayBeforeWifiEducationProperties, options?: {
|
|
1124
|
+
journeyId?: string;
|
|
1125
|
+
stageKey?: string;
|
|
1126
|
+
}): ActionBuilder;
|
|
1098
1127
|
/**
|
|
1099
1128
|
* CreateNewCreditNote
|
|
1100
1129
|
*
|
|
@@ -1355,6 +1355,42 @@ class EmailRecord {
|
|
|
1355
1355
|
};
|
|
1356
1356
|
return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
|
|
1357
1357
|
}
|
|
1358
|
+
/**
|
|
1359
|
+
* CreateInstallDayBeforeWifiEducation
|
|
1360
|
+
*
|
|
1361
|
+
* Creates a new Email record with the specified properties.
|
|
1362
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
1363
|
+
*
|
|
1364
|
+
* @remarks Record type: TRANSACTIONAL
|
|
1365
|
+
*
|
|
1366
|
+
* @param properties - The properties for the new record
|
|
1367
|
+
* @param options - Optional settings
|
|
1368
|
+
* @param options.journeyId - Associate with a journey
|
|
1369
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
1370
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
1371
|
+
*
|
|
1372
|
+
* @example
|
|
1373
|
+
* ```typescript
|
|
1374
|
+
* // Create with properties
|
|
1375
|
+
* const record = odinClient.emails.new();
|
|
1376
|
+
* await record.createInstallDayBeforeWifiEducation({ ... }).execute();
|
|
1377
|
+
*
|
|
1378
|
+
* // Dry run (for debugging)
|
|
1379
|
+
* const payload = record.createInstallDayBeforeWifiEducation({ ... }).dryRun();
|
|
1380
|
+
* ```
|
|
1381
|
+
*/
|
|
1382
|
+
createInstallDayBeforeWifiEducation(properties, options) {
|
|
1383
|
+
const payload = {
|
|
1384
|
+
entity: 'NotificationModule:Email',
|
|
1385
|
+
type: 'TRANSACTIONAL',
|
|
1386
|
+
actionName: 'CreateInstallDayBeforeWifiEducation',
|
|
1387
|
+
properties: properties || {},
|
|
1388
|
+
associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
|
|
1389
|
+
journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
|
|
1390
|
+
stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
|
|
1391
|
+
};
|
|
1392
|
+
return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
|
|
1393
|
+
}
|
|
1358
1394
|
/**
|
|
1359
1395
|
* CreateNewCreditNote
|
|
1360
1396
|
*
|