@d19n/youfibre-odin-sdk 2.0.137 → 2.0.138

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.
@@ -52,7 +52,7 @@ export interface CreateContactProperties {
52
52
  /**
53
53
  * Additional Care Reason
54
54
  *
55
- * Primary reason for additional care (single select). (Sales - Contact)
55
+ * Select a care requirement
56
56
  * @type {ENUM_MULTI_SELECT}
57
57
  * @required
58
58
  * @visibleWhen AdditionalCareRequired = [true]
@@ -109,7 +109,7 @@ export interface CreateContactProperties {
109
109
  /**
110
110
  * Additional Care Notes
111
111
  *
112
- * Free-text notes field for Contact. Used by Sales team for documentation.
112
+ * Any additional information
113
113
  * @type {TEXT_LONG}
114
114
  * @visibleWhen AdditionalCareRequired = [true]
115
115
  */
@@ -21,7 +21,7 @@ export interface CreateInboundCallMessage extends OdinRecordCreatedEvent<CreateI
21
21
  /**
22
22
  * Properties for CreateInboundCall action
23
23
  *
24
- * @property Required fields: 13
24
+ * @property Required fields: 14
25
25
  * @property Optional fields: 1
26
26
  */
27
27
  export interface CreateInboundCallProperties {
@@ -129,6 +129,14 @@ export interface CreateInboundCallProperties {
129
129
  * @required
130
130
  */
131
131
  UserId: string;
132
+ /**
133
+ * TaskQueueSid
134
+ *
135
+ * TaskQueueSid
136
+ * @type {TEXT}
137
+ * @required
138
+ */
139
+ TaskQueueSid: string;
132
140
  /**
133
141
  * QueueName
134
142
  *
@@ -117,7 +117,7 @@ export interface CreateContactProperties {
117
117
  /**
118
118
  * Additional Care Reason
119
119
  *
120
- * Primary reason for additional care (single select). (Sales - Contact)
120
+ * Select a care requirement
121
121
  * @type {ENUM_MULTI_SELECT}
122
122
  * @required
123
123
  * @visibleWhen AdditionalCareRequired = [true]
@@ -174,7 +174,7 @@ export interface CreateContactProperties {
174
174
  /**
175
175
  * Additional Care Notes
176
176
  *
177
- * Free-text notes field for Contact. Used by Sales team for documentation.
177
+ * Any additional information
178
178
  * @type {TEXT_LONG}
179
179
  * @visibleWhen AdditionalCareRequired = [true]
180
180
  */
@@ -60,7 +60,7 @@ export interface UpdateAdditionalCareProperties {
60
60
  /**
61
61
  * Additional Care Requirements
62
62
  *
63
- * Primary reason for additional care (single select). (Sales - Contact)
63
+ * Select a care requirement
64
64
  * @type {ENUM_MULTI_SELECT}
65
65
  * @visibleWhen AdditionalCareRequired = [true,"YES"]
66
66
  */
@@ -68,7 +68,7 @@ export interface UpdateAdditionalCareProperties {
68
68
  /**
69
69
  * Additional Care Notes
70
70
  *
71
- * Free-text notes field for Contact. Used by Sales team for documentation.
71
+ * Any additional information
72
72
  * @type {TEXT_LONG}
73
73
  * @visibleWhen AdditionalCareRequired = [true,"YES"]
74
74
  */
@@ -22,7 +22,7 @@ export interface UpdateContactMessage extends OdinRecordUpdatedEvent<UpdateConta
22
22
  * Properties for UpdateContact action
23
23
  *
24
24
  * @property Required fields: 4
25
- * @property Optional fields: 14
25
+ * @property Optional fields: 12
26
26
  */
27
27
  export interface UpdateContactProperties {
28
28
  /**
@@ -55,7 +55,6 @@ export interface UpdateContactProperties {
55
55
  * Customer consent for recording additional care requiremetns (Sales - Contact)
56
56
  * @type {BOOLEAN}
57
57
  * @required
58
- * @visibleWhen AdditionalCareRequired = [true,"YES"]
59
58
  */
60
59
  AdditionalCareConsent: boolean;
61
60
  /**
@@ -109,42 +108,31 @@ export interface UpdateContactProperties {
109
108
  */
110
109
  CurrentContractType?: string | null;
111
110
  /**
112
- * Critical Dependencies
113
- *
114
- * Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
115
- * @type {ENUM}
116
- */
117
- AdditionalCareRequired?: string | null;
118
- /**
119
- * Medically Dependant
111
+ * Are you medically dependent on your broadband?
120
112
  *
121
113
  * Is the customer medically dependant on their broadband (Sales - Contact)
122
114
  * @type {ENUM}
123
- * @visibleWhen AdditionalCareRequired = [true,"YES"]
124
115
  */
125
116
  MedicallyDependant?: string | null;
126
117
  /**
127
- * Telecare Alarm
118
+ * Do any members of your household rely on a Telecare Alarm?
128
119
  *
129
120
  * Does the customer use a Telecare Alarm (Sales - Contact)
130
121
  * @type {ENUM}
131
- * @visibleWhen AdditionalCareRequired = [true,"YES"]
132
122
  */
133
123
  TelecareAlarm?: string | null;
134
124
  /**
135
- * Additional Care Requirements
125
+ * Additional care requirements?
136
126
  *
137
- * Primary reason for additional care (single select). (Sales - Contact)
127
+ * Select a care requirement
138
128
  * @type {ENUM_MULTI_SELECT}
139
- * @visibleWhen AdditionalCareRequired = [true,"YES"]
140
129
  */
141
130
  AdditionalCareReason?: string | null;
142
131
  /**
143
- * Additional Care Notes
132
+ * Additional care notes
144
133
  *
145
- * Free-text notes field for Contact. Used by Sales team for documentation.
134
+ * Any additional information
146
135
  * @type {TEXT_LONG}
147
- * @visibleWhen AdditionalCareRequired = [true,"YES"]
148
136
  */
149
137
  AdditionalCareNotes?: string | null;
150
138
  }
@@ -21,8 +21,8 @@ export interface UpdateCustomerCallLegOnNumberCallStatusCompletedMessage extends
21
21
  /**
22
22
  * Properties for UpdateCustomerCallLegOnNumberCallStatusCompleted action
23
23
  *
24
- * @property Required fields: 0
25
- * @property Optional fields: 2
24
+ * @property Required fields: 3
25
+ * @property Optional fields: 0
26
26
  */
27
27
  export interface UpdateCustomerCallLegOnNumberCallStatusCompletedProperties {
28
28
  /**
@@ -30,15 +30,25 @@ export interface UpdateCustomerCallLegOnNumberCallStatusCompletedProperties {
30
30
  *
31
31
  * Data field for CallLeg records. Used by Communications team.
32
32
  * @type {DATE_TIME}
33
+ * @required
33
34
  */
34
- EndedAt?: string | null;
35
+ EndedAt: string;
35
36
  /**
36
37
  * Duration
37
38
  *
38
39
  * Duration of THIS leg only in seconds (Communications - CallLeg)
39
40
  * @type {NUMBER}
41
+ * @required
40
42
  */
41
- Duration?: number | null;
43
+ Duration: number;
44
+ /**
45
+ * Status
46
+ *
47
+ * Status indicator for CallLeg records. Tracks lifecycle state. Used by Communications team.
48
+ * @type {ENUM}
49
+ * @required
50
+ */
51
+ Status: string;
42
52
  }
43
53
  /**
44
54
  * UpdateCustomerCallLegOnNumberCallStatusCompleted
@@ -352,15 +352,15 @@ export declare enum ContactPropertyKeys {
352
352
  PortalLastActiveDate = "PortalLastActiveDate",
353
353
  /** When the customer last used or was last active on the native customer mobile app (Sales - Contact) */
354
354
  AppLastActiveDate = "AppLastActiveDate",
355
- /** Free-text notes field for Contact. Used by Sales team for documentation. */
356
- AdditionalCareNotes = "AdditionalCareNotes",
357
355
  /** Is the customer medically dependant on their broadband (Sales - Contact) */
358
356
  MedicallyDependant = "MedicallyDependant",
357
+ /** Any additional information */
358
+ AdditionalCareNotes = "AdditionalCareNotes",
359
359
  /** Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact) */
360
360
  AdditionalCareRequired = "AdditionalCareRequired",
361
361
  /** Does the customer use a Telecare Alarm (Sales - Contact) */
362
362
  TelecareAlarm = "TelecareAlarm",
363
- /** Primary reason for additional care (single select). (Sales - Contact) */
363
+ /** Select a care requirement */
364
364
  AdditionalCareReason = "AdditionalCareReason",
365
365
  /** Phone number (Sales - Contact) */
366
366
  Phone = "Phone"
@@ -667,12 +667,6 @@ export interface ContactProperties {
667
667
  * @hidden This field is hidden in the UI
668
668
  */
669
669
  AppLastActiveDate: string;
670
- /** Free-text notes field for Contact. Used by Sales team for documentation.
671
- *
672
- * @type {TEXT_LONG}
673
- * @hidden This field is hidden in the UI
674
- */
675
- AdditionalCareNotes: string;
676
670
  /** Is the customer medically dependant on their broadband (Sales - Contact)
677
671
  *
678
672
  * @type {ENUM}
@@ -681,6 +675,12 @@ export interface ContactProperties {
681
675
  * @hidden This field is hidden in the UI
682
676
  */
683
677
  MedicallyDependant: ContactMedicallyDependant;
678
+ /** Any additional information
679
+ *
680
+ * @type {TEXT_LONG}
681
+ * @hidden This field is hidden in the UI
682
+ */
683
+ AdditionalCareNotes: string;
684
684
  /** Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
685
685
  *
686
686
  * @type {ENUM}
@@ -696,7 +696,7 @@ export interface ContactProperties {
696
696
  * @hidden This field is hidden in the UI
697
697
  */
698
698
  TelecareAlarm: ContactTelecareAlarm;
699
- /** Primary reason for additional care (single select). (Sales - Contact)
699
+ /** Select a care requirement
700
700
  *
701
701
  * @type {ENUM_MULTI_SELECT}
702
702
  * @hidden This field is hidden in the UI
@@ -337,15 +337,15 @@ var ContactPropertyKeys;
337
337
  ContactPropertyKeys["PortalLastActiveDate"] = "PortalLastActiveDate";
338
338
  /** When the customer last used or was last active on the native customer mobile app (Sales - Contact) */
339
339
  ContactPropertyKeys["AppLastActiveDate"] = "AppLastActiveDate";
340
- /** Free-text notes field for Contact. Used by Sales team for documentation. */
341
- ContactPropertyKeys["AdditionalCareNotes"] = "AdditionalCareNotes";
342
340
  /** Is the customer medically dependant on their broadband (Sales - Contact) */
343
341
  ContactPropertyKeys["MedicallyDependant"] = "MedicallyDependant";
342
+ /** Any additional information */
343
+ ContactPropertyKeys["AdditionalCareNotes"] = "AdditionalCareNotes";
344
344
  /** Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact) */
345
345
  ContactPropertyKeys["AdditionalCareRequired"] = "AdditionalCareRequired";
346
346
  /** Does the customer use a Telecare Alarm (Sales - Contact) */
347
347
  ContactPropertyKeys["TelecareAlarm"] = "TelecareAlarm";
348
- /** Primary reason for additional care (single select). (Sales - Contact) */
348
+ /** Select a care requirement */
349
349
  ContactPropertyKeys["AdditionalCareReason"] = "AdditionalCareReason";
350
350
  /** Phone number (Sales - Contact) */
351
351
  ContactPropertyKeys["Phone"] = "Phone";
@@ -764,11 +764,13 @@ export declare class CallLegRecord<TProps = CallLegProperties> {
764
764
  /**
765
765
  * UpdateCustomerCallLegOnNumberCallStatusCompleted
766
766
  *
767
- * Updates this CallLeg record.
767
+ * Updates this CallLeg record with the specified properties.
768
768
  * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
769
769
  *
770
- * @param propertiesOrOptions - Properties to update, or options object
771
- * @param options - Optional settings (journeyId, stageKey)
770
+ * @param properties - Required properties for this action
771
+ * @param options - Optional settings
772
+ * @param options.journeyId - Associate with a journey
773
+ * @param options.stageKey - Transition to pipeline stage
772
774
  * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
773
775
  * @throws Error if called on a new (unsaved) record
774
776
  *
@@ -781,10 +783,7 @@ export declare class CallLegRecord<TProps = CallLegProperties> {
781
783
  * const payload = record.updateCustomerCallLegOnNumberCallStatusCompleted({ ... }).dryRun();
782
784
  * ```
783
785
  */
784
- updateCustomerCallLegOnNumberCallStatusCompleted(propertiesOrOptions?: UpdateCustomerCallLegOnNumberCallStatusCompletedProperties | {
785
- journeyId?: string;
786
- stageKey?: string;
787
- }, options?: {
786
+ updateCustomerCallLegOnNumberCallStatusCompleted(properties: UpdateCustomerCallLegOnNumberCallStatusCompletedProperties, options?: {
788
787
  journeyId?: string;
789
788
  stageKey?: string;
790
789
  }): ActionBuilder;
@@ -900,11 +900,13 @@ class CallLegRecord {
900
900
  /**
901
901
  * UpdateCustomerCallLegOnNumberCallStatusCompleted
902
902
  *
903
- * Updates this CallLeg record.
903
+ * Updates this CallLeg record with the specified properties.
904
904
  * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
905
905
  *
906
- * @param propertiesOrOptions - Properties to update, or options object
907
- * @param options - Optional settings (journeyId, stageKey)
906
+ * @param properties - Required properties for this action
907
+ * @param options - Optional settings
908
+ * @param options.journeyId - Associate with a journey
909
+ * @param options.stageKey - Transition to pipeline stage
908
910
  * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
909
911
  * @throws Error if called on a new (unsaved) record
910
912
  *
@@ -917,21 +919,11 @@ class CallLegRecord {
917
919
  * const payload = record.updateCustomerCallLegOnNumberCallStatusCompleted({ ... }).dryRun();
918
920
  * ```
919
921
  */
920
- updateCustomerCallLegOnNumberCallStatusCompleted(propertiesOrOptions, options) {
922
+ updateCustomerCallLegOnNumberCallStatusCompleted(properties, options) {
921
923
  var _a;
922
924
  if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
923
925
  throw new Error('updateCustomerCallLegOnNumberCallStatusCompleted requires an existing record. Use accessor.get() first.');
924
- let properties = {};
925
- let opts = options;
926
- if (propertiesOrOptions) {
927
- if ('journeyId' in propertiesOrOptions || 'stageKey' in propertiesOrOptions) {
928
- opts = propertiesOrOptions;
929
- }
930
- else {
931
- properties = propertiesOrOptions;
932
- }
933
- }
934
- const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'UpdateCustomerCallLegOnNumberCallStatusCompleted', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, opts);
926
+ const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'UpdateCustomerCallLegOnNumberCallStatusCompleted', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
935
927
  return new ActionBuilder(this._provider, 'NotificationModule', 'CallLeg', payload, () => { this._pendingLinks = []; });
936
928
  }
937
929
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.137",
3
+ "version": "2.0.138",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",