@d19n/youfibre-odin-sdk 2.0.137 → 2.0.139

package/README.md

@@ -353,7 +353,7 @@ This SDK includes **165** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **687** actions.
+This SDK includes **682** actions.
 
 ### Action Types
 
@@ -1204,15 +1204,10 @@ This SDK includes **687** actions.
 | `UpdateAgentCallLegOnIncomingCallRinging` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateAgentCallLegOnIncomingCallRinging |
 | `UpdateAgentCallLegOnOutboundCallAnswered` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateAgentCallLegOnOutboundCallAnswered |
 | `UpdateAgentCallLegOnOutboundCallCompleted` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateAgentCallLegOnOutboundCallCompleted |
-| `UpdateAgentCallLegOnOutboundCallFailed` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateAgentCallLegOnOutboundCallFailed |
-| `UpdateAgentCallLegOnOutboundCallNoAnswer` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateAgentCallLegOnOutboundCallNoAnswer |
 | `UpdateAgentCallLegOnOutboundCallRinging` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateAgentCallLegOnOutboundCallRinging |
 | `UpdateCall` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCall |
 | `UpdateCustomerCallLegOnIncomingCallAnswered` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallAnswered |
-| `UpdateCustomerCallLegOnIncomingCallCanceled` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCanceled |
 | `UpdateCustomerCallLegOnIncomingCallCompleted` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallCompleted |
-| `UpdateCustomerCallLegOnIncomingCallFailed` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallFailed |
-| `UpdateCustomerCallLegOnIncomingCallNoAnswer` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallNoAnswer |
 | `UpdateCustomerCallLegOnIncomingCallRinging` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnIncomingCallRinging |
 | `UpdateCustomerCallLegOnNumberCallStatusCompleted` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnNumberCallStatusCompleted |
 | `UpdateCustomerCallLegOnOutboundCallAnswered` | UPDATE | k1.t-hEOJjsDb.NotificationModule.CallLeg.Update.UpdateCustomerCallLegOnOutboundCallAnswered |

package/dist/actions-v2/CreateContactDto.d.ts

@@ -52,7 +52,7 @@ export interface CreateContactProperties {
     /**
      * Additional Care Reason
      *
-     * Primary reason for additional care (single select). (Sales - Contact)
+     * Select a care requirement
      * @type {ENUM_MULTI_SELECT}
      * @required
      * @visibleWhen AdditionalCareRequired = [true]
@@ -109,7 +109,7 @@ export interface CreateContactProperties {
     /**
      * Additional Care Notes
      *
-     * Free-text notes field for Contact. Used by Sales team for documentation.
+     * Any additional information
      * @type {TEXT_LONG}
      * @visibleWhen AdditionalCareRequired = [true]
      */

package/dist/actions-v2/CreateInboundCallDto.d.ts

@@ -21,7 +21,7 @@ export interface CreateInboundCallMessage extends OdinRecordCreatedEvent<CreateI
 /**
  * Properties for CreateInboundCall action
  *
- * @property Required fields: 13
+ * @property Required fields: 14
  * @property Optional fields: 1
  */
 export interface CreateInboundCallProperties {
@@ -129,6 +129,14 @@ export interface CreateInboundCallProperties {
      * @required
      */
     UserId: string;
+    /**
+     * TaskQueueSid
+     *
+     * TaskQueueSid
+     * @type {TEXT}
+     * @required
+     */
+    TaskQueueSid: string;
     /**
      * QueueName
      *

package/dist/actions-v2/CreateLeadFromAddressDto.d.ts

@@ -117,7 +117,7 @@ export interface CreateContactProperties {
     /**
      * Additional Care Reason
      *
-     * Primary reason for additional care (single select). (Sales - Contact)
+     * Select a care requirement
      * @type {ENUM_MULTI_SELECT}
      * @required
      * @visibleWhen AdditionalCareRequired = [true]
@@ -174,7 +174,7 @@ export interface CreateContactProperties {
     /**
      * Additional Care Notes
      *
-     * Free-text notes field for Contact. Used by Sales team for documentation.
+     * Any additional information
      * @type {TEXT_LONG}
      * @visibleWhen AdditionalCareRequired = [true]
      */

package/dist/actions-v2/UpdateAdditionalCareDto.d.ts

@@ -60,7 +60,7 @@ export interface UpdateAdditionalCareProperties {
     /**
      * Additional Care Requirements
      *
-     * Primary reason for additional care (single select). (Sales - Contact)
+     * Select a care requirement
      * @type {ENUM_MULTI_SELECT}
      * @visibleWhen AdditionalCareRequired = [true,"YES"]
      */
@@ -68,7 +68,7 @@ export interface UpdateAdditionalCareProperties {
     /**
      * Additional Care Notes
      *
-     * Free-text notes field for Contact. Used by Sales team for documentation.
+     * Any additional information
      * @type {TEXT_LONG}
      * @visibleWhen AdditionalCareRequired = [true,"YES"]
      */

package/dist/actions-v2/UpdateContactDto.d.ts

@@ -22,7 +22,7 @@ export interface UpdateContactMessage extends OdinRecordUpdatedEvent<UpdateConta
  * Properties for UpdateContact action
  *
  * @property Required fields: 4
- * @property Optional fields: 14
+ * @property Optional fields: 12
  */
 export interface UpdateContactProperties {
     /**
@@ -55,7 +55,6 @@ export interface UpdateContactProperties {
      * Customer consent for recording additional care requiremetns (Sales - Contact)
      * @type {BOOLEAN}
      * @required
-     * @visibleWhen AdditionalCareRequired = [true,"YES"]
      */
     AdditionalCareConsent: boolean;
     /**
@@ -109,42 +108,31 @@ export interface UpdateContactProperties {
      */
     CurrentContractType?: string | null;
     /**
-     * Critical Dependencies
-     *
-     * Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
-     * @type {ENUM}
-     */
-    AdditionalCareRequired?: string | null;
-    /**
-     * Medically Dependant
+     * Are you medically dependent on your broadband?
      *
      * Is the customer medically dependant on their broadband (Sales - Contact)
      * @type {ENUM}
-     * @visibleWhen AdditionalCareRequired = [true,"YES"]
      */
     MedicallyDependant?: string | null;
     /**
-     * Telecare Alarm
+     * Do any members of your household rely on a Telecare Alarm?
      *
      * Does the customer use a Telecare Alarm (Sales - Contact)
      * @type {ENUM}
-     * @visibleWhen AdditionalCareRequired = [true,"YES"]
      */
     TelecareAlarm?: string | null;
     /**
-     * Additional Care Requirements
+     * Additional care requirements?
      *
-     * Primary reason for additional care (single select). (Sales - Contact)
+     * Select a care requirement
      * @type {ENUM_MULTI_SELECT}
-     * @visibleWhen AdditionalCareRequired = [true,"YES"]
      */
     AdditionalCareReason?: string | null;
     /**
-     * Additional Care Notes
+     * Additional care notes
      *
-     * Free-text notes field for Contact. Used by Sales team for documentation.
+     * Any additional information
      * @type {TEXT_LONG}
-     * @visibleWhen AdditionalCareRequired = [true,"YES"]
      */
     AdditionalCareNotes?: string | null;
 }

package/dist/actions-v2/UpdateCustomerCallLegOnNumberCallStatusCompletedDto.d.ts

@@ -21,8 +21,8 @@ export interface UpdateCustomerCallLegOnNumberCallStatusCompletedMessage extends
 /**
  * Properties for UpdateCustomerCallLegOnNumberCallStatusCompleted action
  *
- * @property Required fields: 0
- * @property Optional fields: 2
+ * @property Required fields: 3
+ * @property Optional fields: 0
  */
 export interface UpdateCustomerCallLegOnNumberCallStatusCompletedProperties {
     /**
@@ -30,15 +30,25 @@ export interface UpdateCustomerCallLegOnNumberCallStatusCompletedProperties {
      *
      * Data field for CallLeg records. Used by Communications team.
      * @type {DATE_TIME}
+     * @required
      */
-    EndedAt?: string | null;
+    EndedAt: string;
     /**
      * Duration
      *
      * Duration of THIS leg only in seconds (Communications - CallLeg)
      * @type {NUMBER}
+     * @required
      */
-    Duration?: number | null;
+    Duration: number;
+    /**
+     * Status
+     *
+     * Status indicator for CallLeg records. Tracks lifecycle state. Used by Communications team.
+     * @type {ENUM}
+     * @required
+     */
+    Status: string;
 }
 /**
  * UpdateCustomerCallLegOnNumberCallStatusCompleted

package/dist/entities-v2/Contact.d.ts

@@ -352,15 +352,15 @@ export declare enum ContactPropertyKeys {
     PortalLastActiveDate = "PortalLastActiveDate",
     /** When the customer last used or was last active on the native customer mobile app (Sales - Contact) */
     AppLastActiveDate = "AppLastActiveDate",
-    /** Free-text notes field for Contact. Used by Sales team for documentation. */
-    AdditionalCareNotes = "AdditionalCareNotes",
     /** Is the customer medically dependant on their broadband (Sales - Contact) */
     MedicallyDependant = "MedicallyDependant",
+    /** Any additional information */
+    AdditionalCareNotes = "AdditionalCareNotes",
     /** Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact) */
     AdditionalCareRequired = "AdditionalCareRequired",
     /** Does the customer use a Telecare Alarm (Sales - Contact) */
     TelecareAlarm = "TelecareAlarm",
-    /** Primary reason for additional care (single select). (Sales - Contact) */
+    /** Select a care requirement */
     AdditionalCareReason = "AdditionalCareReason",
     /** Phone number (Sales - Contact) */
     Phone = "Phone"
@@ -667,12 +667,6 @@ export interface ContactProperties {
      * @hidden This field is hidden in the UI
      */
     AppLastActiveDate: string;
-    /** Free-text notes field for Contact. Used by Sales team for documentation.
-     *
-     * @type {TEXT_LONG}
-     * @hidden This field is hidden in the UI
-     */
-    AdditionalCareNotes: string;
     /** Is the customer medically dependant on their broadband (Sales - Contact)
      *
      * @type {ENUM}
@@ -681,6 +675,12 @@ export interface ContactProperties {
      * @hidden This field is hidden in the UI
      */
     MedicallyDependant: ContactMedicallyDependant;
+    /** Any additional information
+     *
+     * @type {TEXT_LONG}
+     * @hidden This field is hidden in the UI
+     */
+    AdditionalCareNotes: string;
     /** Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
      *
      * @type {ENUM}
@@ -696,7 +696,7 @@ export interface ContactProperties {
      * @hidden This field is hidden in the UI
      */
     TelecareAlarm: ContactTelecareAlarm;
-    /** Primary reason for additional care (single select). (Sales - Contact)
+    /** Select a care requirement
      *
      * @type {ENUM_MULTI_SELECT}
      * @hidden This field is hidden in the UI

package/dist/entities-v2/Contact.js

@@ -337,15 +337,15 @@ var ContactPropertyKeys;
     ContactPropertyKeys["PortalLastActiveDate"] = "PortalLastActiveDate";
     /** When the customer last used or was last active on the native customer mobile app (Sales - Contact) */
     ContactPropertyKeys["AppLastActiveDate"] = "AppLastActiveDate";
-    /** Free-text notes field for Contact. Used by Sales team for documentation. */
-    ContactPropertyKeys["AdditionalCareNotes"] = "AdditionalCareNotes";
     /** Is the customer medically dependant on their broadband (Sales - Contact) */
     ContactPropertyKeys["MedicallyDependant"] = "MedicallyDependant";
+    /** Any additional information */
+    ContactPropertyKeys["AdditionalCareNotes"] = "AdditionalCareNotes";
     /** Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact) */
     ContactPropertyKeys["AdditionalCareRequired"] = "AdditionalCareRequired";
     /** Does the customer use a Telecare Alarm (Sales - Contact) */
     ContactPropertyKeys["TelecareAlarm"] = "TelecareAlarm";
-    /** Primary reason for additional care (single select). (Sales - Contact) */
+    /** Select a care requirement */
     ContactPropertyKeys["AdditionalCareReason"] = "AdditionalCareReason";
     /** Phone number (Sales - Contact) */
     ContactPropertyKeys["Phone"] = "Phone";

package/dist/records-v2/CallLegRecord.d.ts

@@ -33,15 +33,10 @@ import { UpdateAgentCallLegOnIncomingCallNoAnswerProperties } from '../actions-v
 import { UpdateAgentCallLegOnIncomingCallRingingProperties } from '../actions-v2/UpdateAgentCallLegOnIncomingCallRingingDto';
 import { UpdateAgentCallLegOnOutboundCallAnsweredProperties } from '../actions-v2/UpdateAgentCallLegOnOutboundCallAnsweredDto';
 import { UpdateAgentCallLegOnOutboundCallCompletedProperties } from '../actions-v2/UpdateAgentCallLegOnOutboundCallCompletedDto';
-import { UpdateAgentCallLegOnOutboundCallFailedProperties } from '../actions-v2/UpdateAgentCallLegOnOutboundCallFailedDto';
-import { UpdateAgentCallLegOnOutboundCallNoAnswerProperties } from '../actions-v2/UpdateAgentCallLegOnOutboundCallNoAnswerDto';
 import { UpdateAgentCallLegOnOutboundCallRingingProperties } from '../actions-v2/UpdateAgentCallLegOnOutboundCallRingingDto';
 import { UpdateCallProperties } from '../actions-v2/UpdateCallDto';
 import { UpdateCustomerCallLegOnIncomingCallAnsweredProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallAnsweredDto';
-import { UpdateCustomerCallLegOnIncomingCallCanceledProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallCanceledDto';
 import { UpdateCustomerCallLegOnIncomingCallCompletedProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallCompletedDto';
-import { UpdateCustomerCallLegOnIncomingCallFailedProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallFailedDto';
-import { UpdateCustomerCallLegOnIncomingCallNoAnswerProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallNoAnswerDto';
 import { UpdateCustomerCallLegOnIncomingCallRingingProperties } from '../actions-v2/UpdateCustomerCallLegOnIncomingCallRingingDto';
 import { UpdateCustomerCallLegOnNumberCallStatusCompletedProperties } from '../actions-v2/UpdateCustomerCallLegOnNumberCallStatusCompletedDto';
 import { UpdateCustomerCallLegOnOutboundCallAnsweredProperties } from '../actions-v2/UpdateCustomerCallLegOnOutboundCallAnsweredDto';
@@ -500,58 +495,6 @@ export declare class CallLegRecord<TProps = CallLegProperties> {
         journeyId?: string;
         stageKey?: string;
     }): ActionBuilder;
-    /**
-     * UpdateAgentCallLegOnOutboundCallFailed
-     *
-     * Updates this CallLeg record with the specified properties.
-     * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
-     *
-     * @param properties - Required properties for this action
-     * @param options - Optional settings
-     * @param options.journeyId - Associate with a journey
-     * @param options.stageKey - Transition to pipeline stage
-     * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
-     * @throws Error if called on a new (unsaved) record
-     *
-     * @example
-     * ```typescript
-     * const record = await odinClient.callLegs.get(id);
-     * await record.updateAgentCallLegOnOutboundCallFailed({ ... }).execute();
-     *
-     * // Dry run (for debugging)
-     * const payload = record.updateAgentCallLegOnOutboundCallFailed({ ... }).dryRun();
-     * ```
-     */
-    updateAgentCallLegOnOutboundCallFailed(properties: UpdateAgentCallLegOnOutboundCallFailedProperties, options?: {
-        journeyId?: string;
-        stageKey?: string;
-    }): ActionBuilder;
-    /**
-     * UpdateAgentCallLegOnOutboundCallNoAnswer
-     *
-     * Updates this CallLeg record with the specified properties.
-     * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
-     *
-     * @param properties - Required properties for this action
-     * @param options - Optional settings
-     * @param options.journeyId - Associate with a journey
-     * @param options.stageKey - Transition to pipeline stage
-     * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
-     * @throws Error if called on a new (unsaved) record
-     *
-     * @example
-     * ```typescript
-     * const record = await odinClient.callLegs.get(id);
-     * await record.updateAgentCallLegOnOutboundCallNoAnswer({ ... }).execute();
-     *
-     * // Dry run (for debugging)
-     * const payload = record.updateAgentCallLegOnOutboundCallNoAnswer({ ... }).dryRun();
-     * ```
-     */
-    updateAgentCallLegOnOutboundCallNoAnswer(properties: UpdateAgentCallLegOnOutboundCallNoAnswerProperties, options?: {
-        journeyId?: string;
-        stageKey?: string;
-    }): ActionBuilder;
     /**
      * UpdateAgentCallLegOnOutboundCallRinging
      *
@@ -631,32 +574,6 @@ export declare class CallLegRecord<TProps = CallLegProperties> {
         journeyId?: string;
         stageKey?: string;
     }): ActionBuilder;
-    /**
-     * UpdateCustomerCallLegOnIncomingCallCanceled
-     *
-     * Updates this CallLeg record with the specified properties.
-     * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
-     *
-     * @param properties - Required properties for this action
-     * @param options - Optional settings
-     * @param options.journeyId - Associate with a journey
-     * @param options.stageKey - Transition to pipeline stage
-     * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
-     * @throws Error if called on a new (unsaved) record
-     *
-     * @example
-     * ```typescript
-     * const record = await odinClient.callLegs.get(id);
-     * await record.updateCustomerCallLegOnIncomingCallCanceled({ ... }).execute();
-     *
-     * // Dry run (for debugging)
-     * const payload = record.updateCustomerCallLegOnIncomingCallCanceled({ ... }).dryRun();
-     * ```
-     */
-    updateCustomerCallLegOnIncomingCallCanceled(properties: UpdateCustomerCallLegOnIncomingCallCanceledProperties, options?: {
-        journeyId?: string;
-        stageKey?: string;
-    }): ActionBuilder;
     /**
      * UpdateCustomerCallLegOnIncomingCallCompleted
      *
@@ -683,58 +600,6 @@ export declare class CallLegRecord<TProps = CallLegProperties> {
         journeyId?: string;
         stageKey?: string;
     }): ActionBuilder;
-    /**
-     * UpdateCustomerCallLegOnIncomingCallFailed
-     *
-     * Updates this CallLeg record with the specified properties.
-     * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
-     *
-     * @param properties - Required properties for this action
-     * @param options - Optional settings
-     * @param options.journeyId - Associate with a journey
-     * @param options.stageKey - Transition to pipeline stage
-     * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
-     * @throws Error if called on a new (unsaved) record
-     *
-     * @example
-     * ```typescript
-     * const record = await odinClient.callLegs.get(id);
-     * await record.updateCustomerCallLegOnIncomingCallFailed({ ... }).execute();
-     *
-     * // Dry run (for debugging)
-     * const payload = record.updateCustomerCallLegOnIncomingCallFailed({ ... }).dryRun();
-     * ```
-     */
-    updateCustomerCallLegOnIncomingCallFailed(properties: UpdateCustomerCallLegOnIncomingCallFailedProperties, options?: {
-        journeyId?: string;
-        stageKey?: string;
-    }): ActionBuilder;
-    /**
-     * UpdateCustomerCallLegOnIncomingCallNoAnswer
-     *
-     * Updates this CallLeg record with the specified properties.
-     * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
-     *
-     * @param properties - Required properties for this action
-     * @param options - Optional settings
-     * @param options.journeyId - Associate with a journey
-     * @param options.stageKey - Transition to pipeline stage
-     * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
-     * @throws Error if called on a new (unsaved) record
-     *
-     * @example
-     * ```typescript
-     * const record = await odinClient.callLegs.get(id);
-     * await record.updateCustomerCallLegOnIncomingCallNoAnswer({ ... }).execute();
-     *
-     * // Dry run (for debugging)
-     * const payload = record.updateCustomerCallLegOnIncomingCallNoAnswer({ ... }).dryRun();
-     * ```
-     */
-    updateCustomerCallLegOnIncomingCallNoAnswer(properties: UpdateCustomerCallLegOnIncomingCallNoAnswerProperties, options?: {
-        journeyId?: string;
-        stageKey?: string;
-    }): ActionBuilder;
     /**
      * UpdateCustomerCallLegOnIncomingCallRinging
      *
@@ -764,11 +629,13 @@ export declare class CallLegRecord<TProps = CallLegProperties> {
     /**
      * UpdateCustomerCallLegOnNumberCallStatusCompleted
      *
-     * Updates this CallLeg record.
+     * Updates this CallLeg record with the specified properties.
      * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
      *
-     * @param propertiesOrOptions - Properties to update, or options object
-     * @param options - Optional settings (journeyId, stageKey)
+     * @param properties - Required properties for this action
+     * @param options - Optional settings
+     * @param options.journeyId - Associate with a journey
+     * @param options.stageKey - Transition to pipeline stage
      * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
      * @throws Error if called on a new (unsaved) record
      *
@@ -781,10 +648,7 @@ export declare class CallLegRecord<TProps = CallLegProperties> {
      * const payload = record.updateCustomerCallLegOnNumberCallStatusCompleted({ ... }).dryRun();
      * ```
      */
-    updateCustomerCallLegOnNumberCallStatusCompleted(propertiesOrOptions?: UpdateCustomerCallLegOnNumberCallStatusCompletedProperties | {
-        journeyId?: string;
-        stageKey?: string;
-    }, options?: {
+    updateCustomerCallLegOnNumberCallStatusCompleted(properties: UpdateCustomerCallLegOnNumberCallStatusCompletedProperties, options?: {
         journeyId?: string;
         stageKey?: string;
     }): ActionBuilder;