@d19n/youfibre-odin-sdk 2.0.337 → 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.
@@ -87,7 +87,7 @@ export interface CreateCollectionAmcoWorkOrderProperties {
87
87
  /**
88
88
  * Source
89
89
  *
90
- * Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- * Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- * Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- * Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
75
+ * Source of WO creation
76
76
  * @type {ENUM}
77
77
  */
78
78
  Source?: string | null;
@@ -22,8 +22,80 @@ export interface CreateInstallDayBeforeWifiEducationMessage extends OdinRecordCr
22
22
  /**
23
23
  * Properties for CreateInstallDayBeforeWifiEducation action
24
24
  *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 10
25
27
  */
26
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;
27
99
  }
28
100
  /**
29
101
  * CreateInstallDayBeforeWifiEducation
@@ -1399,15 +1399,19 @@ export declare enum WorkOrderPreventableWorkOrder {
1399
1399
  /**
1400
1400
  * Valid values for WorkOrder.Source
1401
1401
  *
1402
- * Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders. */
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- * Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
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
- /** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders. */
1697
+ /** Source of WO creation */
1694
1698
  WorkOrderPropertyKeys["Source"] = "Source";
1695
1699
  })(WorkOrderPropertyKeys = exports.WorkOrderPropertyKeys || (exports.WorkOrderPropertyKeys = {}));
1696
1700
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.337",
3
+ "version": "2.0.338",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",