@d19n/youfibre-odin-sdk 2.0.271 → 2.0.272

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.
@@ -22,9 +22,17 @@ export interface CreateConversationMessage extends OdinRecordCreatedEvent<Create
22
22
  * Properties for CreateConversation action
23
23
  *
24
24
  * @property Required fields: 1
25
- * @property Optional fields: 2
25
+ * @property Optional fields: 4
26
26
  */
27
27
  export interface CreateConversationProperties {
28
+ /**
29
+ * ExternalId
30
+ *
31
+ * Unique External ID (Conversation SID / Conversation ID) (Communications - Conversation)
32
+ * @type {TEXT}
33
+ * @required
34
+ */
35
+ ExternalId: string;
28
36
  /**
29
37
  * Channel
30
38
  *
@@ -39,6 +47,20 @@ export interface CreateConversationProperties {
39
47
  * @type {ENUM}
40
48
  */
41
49
  Status?: string | null;
50
+ /**
51
+ * Source
52
+ *
53
+ * Source for the conversaion (TWILIO, TRUSTPILOT, and other possible provider) (Communications - Conversation)
54
+ * @type {ENUM}
55
+ */
56
+ Source?: string | null;
57
+ /**
58
+ * Mode
59
+ *
60
+ * Conversation Mode
61
+ * @type {ENUM}
62
+ */
63
+ Mode?: string | null;
42
64
  }
43
65
  /**
44
66
  * CreateConversation
@@ -22,8 +22,8 @@ export interface CreateMessageMessage extends OdinRecordCreatedEvent<CreateMessa
22
22
  /**
23
23
  * Properties for CreateMessage action
24
24
  *
25
- * @property Required fields: 5
26
- * @property Optional fields: 2
25
+ * @property Required fields: 4
26
+ * @property Optional fields: 4
27
27
  */
28
28
  export interface CreateMessageProperties {
29
29
  /**
@@ -35,7 +35,7 @@ export interface CreateMessageProperties {
35
35
  */
36
36
  Body: string;
37
37
  /**
38
- * The title of the record
38
+ * Title
39
39
  *
40
40
  * Title field for the record
41
41
  * @type {TEXT}
@@ -58,14 +58,6 @@ export interface CreateMessageProperties {
58
58
  * @required
59
59
  */
60
60
  From: string;
61
- /**
62
- * To
63
- *
64
- * Who receive the message (if needed) (Communications - Message)
65
- * @type {TEXT}
66
- * @required
67
- */
68
- To: string;
69
61
  /**
70
62
  * ExternalId
71
63
  *
@@ -80,6 +72,20 @@ export interface CreateMessageProperties {
80
72
  * @type {FILE_MULTIPLE}
81
73
  */
82
74
  Files?: string | null;
75
+ /**
76
+ * To
77
+ *
78
+ * Who receive the message (if needed) (Communications - Message)
79
+ * @type {TEXT}
80
+ */
81
+ To?: string | null;
82
+ /**
83
+ * Status
84
+ *
85
+ * Status of the message (CREATED,DELETED) (Communications - Message)
86
+ * @type {TEXT}
87
+ */
88
+ Status?: string | null;
83
89
  }
84
90
  /**
85
91
  * CreateMessage
@@ -552,6 +552,8 @@ export declare enum OrderPropertyKeys {
552
552
  RequestedActivationDate = "RequestedActivationDate",
553
553
  /** I have read and confirm receipt of the Contract Summary. I consent to the Privacy Policy and acknowledge receipt of the T&Cs. (Sales - Contact) */
554
554
  ContractConsent = "ContractConsent",
555
+ /** The early termination fee quoted for this order (VAT-inclusive, totalGross from the ETF quote calculation). Written by EarlyTerminationService.getQuote on every quote call, for any caller and any atDate — a hypothetical quote overwrites the "as of now" value (deliberate, see CASES-1640). Direct input to the ETF <= £330 eligibility rule in the product-selection flow (WEB-1421 / PORTAPP-2651). */
556
+ EarlyTerminationFee = "EarlyTerminationFee",
555
557
  /** AltContactMethod */
556
558
  AltContactMethod = "AltContactMethod",
557
559
  /** MobileCoverage */
@@ -1150,6 +1152,12 @@ export interface OrderProperties {
1150
1152
  * @type {BOOLEAN}
1151
1153
  */
1152
1154
  ContractConsent: boolean;
1155
+ /** The early termination fee quoted for this order (VAT-inclusive, totalGross from the ETF quote calculation). Written by EarlyTerminationService.getQuote on every quote call, for any caller and any atDate — a hypothetical quote overwrites the "as of now" value (deliberate, see CASES-1640). Direct input to the ETF <= £330 eligibility rule in the product-selection flow (WEB-1421 / PORTAPP-2651).
1156
+ *
1157
+ * @type {NUMBER}
1158
+ * @default
1159
+ */
1160
+ EarlyTerminationFee: number;
1153
1161
  /** AltContactMethod
1154
1162
  *
1155
1163
  * @type {ENUM}
@@ -536,6 +536,8 @@ var OrderPropertyKeys;
536
536
  OrderPropertyKeys["RequestedActivationDate"] = "RequestedActivationDate";
537
537
  /** I have read and confirm receipt of the Contract Summary. I consent to the Privacy Policy and acknowledge receipt of the T&Cs. (Sales - Contact) */
538
538
  OrderPropertyKeys["ContractConsent"] = "ContractConsent";
539
+ /** The early termination fee quoted for this order (VAT-inclusive, totalGross from the ETF quote calculation). Written by EarlyTerminationService.getQuote on every quote call, for any caller and any atDate — a hypothetical quote overwrites the "as of now" value (deliberate, see CASES-1640). Direct input to the ETF <= £330 eligibility rule in the product-selection flow (WEB-1421 / PORTAPP-2651). */
540
+ OrderPropertyKeys["EarlyTerminationFee"] = "EarlyTerminationFee";
539
541
  /** AltContactMethod */
540
542
  OrderPropertyKeys["AltContactMethod"] = "AltContactMethod";
541
543
  /** MobileCoverage */
@@ -257,7 +257,7 @@ export declare class ConversationRecord<TProps = ConversationProperties> {
257
257
  * const payload = record.createConversation({ ... }).dryRun();
258
258
  * ```
259
259
  */
260
- createConversation(properties?: CreateConversationProperties, options?: {
260
+ createConversation(properties: CreateConversationProperties, options?: {
261
261
  type?: string;
262
262
  journeyId?: string;
263
263
  stageKey?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.271",
3
+ "version": "2.0.272",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",