@d19n/youfibre-odin-sdk 2.0.172 → 2.0.176

package/README.md

@@ -354,7 +354,7 @@ This SDK includes **166** entities across **12** modules.
 
 ## Actions
 
-This SDK includes **684** actions.
+This SDK includes **686** actions.
 
 ### Action Types
 
@@ -561,8 +561,6 @@ This SDK includes **684** actions.
 | `MoveServiceWorkOrderToCancelled` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderToCancelled |
 | `MoveServiceWorkOrderToEnRoute` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderToEnRoute |
 | `MoveServiceWorkOrderToEnRouteSupplier` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderToEnRouteSupplier |
-| `MoveServiceWorkOrderToInProgress` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderToInProgress |
-| `MoveServiceWorkOrderToInProgressSupplier` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderToInProgressSupplier |
 | `MoveServiceWorkOrderToRemediationSupplier` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveServiceWorkOrderToRemediationSupplier |
 | `MoveWayleaveWorkOrderToAwaitingPtd` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveWayleaveWorkOrderToAwaitingPtd |
 | `MoveWayleaveWorkOrderToCancelled` | STAGE_TRANSITION | k1.t-hEOJjsDb.FieldServiceModule.WorkOrder.Transition.MoveWayleaveWorkOrderToCancelled |
@@ -754,10 +752,6 @@ This SDK includes **684** actions.
 
 **MoveServiceWorkOrderToEnRouteSupplier Target Stages:** `WorkOrderStageEnRoute`
 
-**MoveServiceWorkOrderToInProgress Target Stages:** `WorkOrderStageInProgress`
-
-**MoveServiceWorkOrderToInProgressSupplier Target Stages:** `WorkOrderStageInProgress`
-
 **MoveServiceWorkOrderToRemediationSupplier Target Stages:** `WorkOrderRemediationRequired`
 
 **MoveWayleaveWorkOrderToAwaitingPtd Target Stages:** `WayleavePipelineStageAwaitingPtd`
@@ -1337,6 +1331,7 @@ This SDK includes **684** actions.
 | `UpdateAdditionalCare` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateAdditionalCare |
 | `UpdateContact` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateContact |
 | `UpdateReferralCode` | UPDATE | k1.t-hEOJjsDb.CrmModule.Contact.Update.UpdateReferralCode |
+| `UpdateWhitelistQueueAndEndTime` | CREATE | k1.t-hEOJjsDb.CrmModule.Contact.Create.UpdateWhitelistQueueAndEndTime |
 
 #### ContactIdentity
 
@@ -1851,6 +1846,20 @@ This SDK includes **684** actions.
 | `SalesTerritoryCreate` | CREATE | k1.t-hEOJjsDb.CrmModule.SalesTerritory.Create.SalesTerritoryCreate |
 | `SalesTerritoryUpdate` | UPDATE | k1.t-hEOJjsDb.CrmModule.SalesTerritory.Update.SalesTerritoryUpdate |
 
+#### SiteSpecificRiskAssessmentOutcomeForm
+
+| Action | Type | Event |
+|--------|------|-------|
+| `CreateSsra` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
+| `MoveInspectionWorkOrderToInProgressSubstantial` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
+| `MoveInstallWorkOrderToInProgressSubstantial` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
+| `MovePrePullWorkOrderToInProgressSubstantial` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
+| `MoveRemediationWorkOrderToInProgressSubstantial` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
+| `MoveServiceWorkOrderToInProgress` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
+| `MoveServiceWorkOrderToInProgressSubstantial` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
+| `MoveServiceWorkOrderToInProgressSupplier` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
+| `UpdateSsra` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Update.UpdateSsra |
+
 #### Team
 
 | Action | Type | Event |
@@ -1953,17 +1962,6 @@ This SDK includes **684** actions.
 | `KnowledgeArticleReleaseNoteCreate` | CREATE | k1.t-hEOJjsDb.SupportModule.KnowledgeArticle.Create.KnowledgeArticleReleaseNoteCreate |
 | `KnowledgeArticleUserGuideCreate` | CREATE | k1.t-hEOJjsDb.SupportModule.KnowledgeArticle.Create.KnowledgeArticleUserGuideCreate |
 
-#### SiteSpecificRiskAssessmentOutcomeForm
-
-| Action | Type | Event |
-|--------|------|-------|
-| `MoveInspectionWorkOrderToInProgressSubstantial` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
-| `MoveInstallWorkOrderToInProgressSubstantial` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
-| `MovePrePullWorkOrderToInProgressSubstantial` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
-| `MoveRemediationWorkOrderToInProgressSubstantial` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
-| `MoveServiceWorkOrderToInProgressSubstantial` | CREATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra |
-| `UpdateSsra` | UPDATE | k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Update.UpdateSsra |
-
 #### Outage
 
 | Action | Type | Event |

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

@@ -21,8 +21,8 @@ export interface CreateContactMessage extends OdinRecordCreatedEvent<CreateConta
 /**
  * Properties for CreateContact action
  *
- * @property Required fields: 7
- * @property Optional fields: 4
+ * @property Required fields: 3
+ * @property Optional fields: 3
  */
 export interface CreateContactProperties {
     /**
@@ -49,42 +49,6 @@ export interface CreateContactProperties {
      * @required
      */
     EmailAddress: string;
-    /**
-     * Additional Care Reason
-     *
-     * Select a care requirement
-     * @type {ENUM_MULTI_SELECT}
-     * @required
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    AdditionalCareReason: string;
-    /**
-     * Medically Dependant
-     *
-     * Is the customer medically dependant on their broadband (Sales - Contact)
-     * @type {ENUM}
-     * @required
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    MedicallyDependant: string;
-    /**
-     * Telecare Alarm
-     *
-     * Does the customer use a Telecare Alarm (Sales - Contact)
-     * @type {ENUM}
-     * @required
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    TelecareAlarm: string;
-    /**
-     * Additional Care Consent
-     *
-     * Customer consent for recording additional care requiremetns (Sales - Contact)
-     * @type {BOOLEAN}
-     * @required
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    AdditionalCareConsent: boolean;
     /**
      * MarketingConsent
      *
@@ -99,21 +63,6 @@ export interface CreateContactProperties {
      * @type {PHONE_NUMBER_E164_GB}
      */
     Phone?: string | null;
-    /**
-     * Additional Care Required
-     *
-     * Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
-     * @type {ENUM}
-     */
-    AdditionalCareRequired?: string | null;
-    /**
-     * Additional Care Notes
-     *
-     * Any additional information
-     * @type {TEXT_LONG}
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    AdditionalCareNotes?: string | null;
 }
 /**
  * CreateContact

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

@@ -86,8 +86,8 @@ export declare class CreateLeadDto extends OdinRecordCreateDto<CreateLeadPropert
 /**
  * Properties for CreateContact action
  *
- * @property Required fields: 7
- * @property Optional fields: 4
+ * @property Required fields: 3
+ * @property Optional fields: 3
  */
 export interface CreateContactProperties {
     /**
@@ -114,42 +114,6 @@ export interface CreateContactProperties {
      * @required
      */
     EmailAddress: string;
-    /**
-     * Additional Care Reason
-     *
-     * Select a care requirement
-     * @type {ENUM_MULTI_SELECT}
-     * @required
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    AdditionalCareReason: string;
-    /**
-     * Medically Dependant
-     *
-     * Is the customer medically dependant on their broadband (Sales - Contact)
-     * @type {ENUM}
-     * @required
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    MedicallyDependant: string;
-    /**
-     * Telecare Alarm
-     *
-     * Does the customer use a Telecare Alarm (Sales - Contact)
-     * @type {ENUM}
-     * @required
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    TelecareAlarm: string;
-    /**
-     * Additional Care Consent
-     *
-     * Customer consent for recording additional care requiremetns (Sales - Contact)
-     * @type {BOOLEAN}
-     * @required
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    AdditionalCareConsent: boolean;
     /**
      * MarketingConsent
      *
@@ -164,21 +128,6 @@ export interface CreateContactProperties {
      * @type {PHONE_NUMBER_E164_GB}
      */
     Phone?: string | null;
-    /**
-     * Additional Care Required
-     *
-     * Marks if the customer requires additional care (Ofcom vulnerable customer handling). (Sales - Contact)
-     * @type {ENUM}
-     */
-    AdditionalCareRequired?: string | null;
-    /**
-     * Additional Care Notes
-     *
-     * Any additional information
-     * @type {TEXT_LONG}
-     * @visibleWhen AdditionalCareRequired = [true]
-     */
-    AdditionalCareNotes?: string | null;
 }
 /**
  * CreateContact

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

@@ -0,0 +1,232 @@
+/**
+ * CreateSsra Action DTO
+ *
+ * @module FieldServiceModule
+ * @entity SiteSpecificRiskAssessmentOutcomeForm
+ * @actionKey CreateSsra
+ * @event k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
+/**
+ * RabbitMQ message payload for CreateSsra created events
+ *
+ * @event k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra
+ */
+export interface CreateSsraMessage extends OdinRecordCreatedEvent<CreateSsraDto, CreateSsraProperties> {
+}
+/**
+ * Properties for CreateSsra action
+ *
+ * @property Required fields: 18
+ * @property Optional fields: 4
+ */
+export interface CreateSsraProperties {
+    /**
+     * FitAndWellToCompleteJob
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {ENUM}
+     * @required
+     */
+    FitAndWellToCompleteJob: string;
+    /**
+     * CorrectPpe
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {ENUM}
+     * @required
+     */
+    CorrectPpe: string;
+    /**
+     * AnyOtherIndividualsOnTheSite
+     *
+     * Reference identifier for SiteSpecificRiskAssessmentOutcomeForm relationships. Used for data integrity.
+     * @type {ENUM}
+     * @required
+     */
+    AnyOtherIndividualsOnTheSite: string;
+    /**
+     * OtherIndividualsNames
+     *
+     * Reference identifier for SiteSpecificRiskAssessmentOutcomeForm relationships. Used for data integrity.
+     * @type {TEXT_LONG}
+     * @required
+     * @visibleWhen AnyOtherIndividualsOnTheSite = ["YES"]
+     */
+    OtherIndividualsNames: string;
+    /**
+     * AccessToRiskAssessmentAndSafeSystemOfWork
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {ENUM}
+     * @required
+     */
+    AccessToRiskAssessmentAndSafeSystemOfWork: string;
+    /**
+     * PeoplesafeActivated
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {ENUM}
+     * @required
+     */
+    PeoplesafeActivated: string;
+    /**
+     * AnimalsAndPetsLockedAway
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {ENUM}
+     * @required
+     */
+    AnimalsAndPetsLockedAway: string;
+    /**
+     * WorkAreaFreeFromHazards
+     * @type {ENUM}
+     * @required
+     */
+    WorkAreaFreeFromHazards: string;
+    /**
+     * CompletingDrillingWithinProperty
+     * @type {ENUM}
+     * @required
+     */
+    CompletingDrillingWithinProperty: string;
+    /**
+     * SafetyGlassesEarDefendersDustMaskAvailable
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {ENUM}
+     * @required
+     * @visibleWhen CompletingDrillingWithinProperty = ["YES"]
+     */
+    SafetyGlassesEarDefendersDustMaskAvailable: string;
+    /**
+     * DrillConfirmationOntMountPhoto
+     *
+     * Please add image (Field Operations - SiteSpecificRiskAssessmentOutcomeForm)
+     * @type {FILE_MULTIPLE}
+     * @required
+     * @visibleWhen CompletingDrillingWithinProperty = ["YES"]
+     */
+    DrillConfirmationOntMountPhoto: string;
+    /**
+     * DrillConfirmationDrillOutPhoto
+     *
+     * Please add image (Field Operations - SiteSpecificRiskAssessmentOutcomeForm)
+     * @type {FILE_MULTIPLE}
+     * @required
+     * @visibleWhen CompletingDrillingWithinProperty = ["YES"]
+     */
+    DrillConfirmationDrillOutPhoto: string;
+    /**
+     * EquipmentDefects
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {ENUM}
+     * @required
+     */
+    EquipmentDefects: string;
+    /**
+     * AreThereAnyAdditionalHazards
+     * @type {ENUM}
+     * @required
+     */
+    AreThereAnyAdditionalHazards: string;
+    /**
+     * AdditionalControlsOnSite
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {TEXT_LONG}
+     * @required
+     * @visibleWhen AreThereAnyAdditionalHazards = ["YES"]
+     */
+    AdditionalControlsOnSite: string;
+    /**
+     * AdditionalControlsOnSitePhoto
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {FILE_MULTIPLE}
+     * @required
+     * @visibleWhen AreThereAnyAdditionalHazards = ["YES"]
+     */
+    AdditionalControlsOnSitePhoto: string;
+    /**
+     * ActivitySafe
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {ENUM}
+     * @required
+     */
+    ActivitySafe: string;
+    /**
+     * ActivityUnsafeExplanation
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {TEXT_LONG}
+     * @required
+     * @visibleWhen ActivitySafe = ["UNSAFE"]
+     */
+    ActivityUnsafeExplanation: string;
+    /**
+     * SsraStatement
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {TEXT}
+     */
+    SsraStatement?: string | null;
+    /**
+     * FitnessAlert
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {TEXT}
+     * @visibleWhen FitAndWellToCompleteJob = ["NO"]
+     */
+    FitnessAlert?: string | null;
+    /**
+     * PpeAlert
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {TEXT}
+     * @visibleWhen CorrectPpe = ["NO"]
+     */
+    PpeAlert?: string | null;
+    /**
+     * EquipmentDefectiveAlert
+     *
+     * Data field for SiteSpecificRiskAssessmentOutcomeForm records. Used by Field Operations team.
+     * @type {TEXT}
+     * @visibleWhen EquipmentDefects = ["DEFECTIVE"]
+     */
+    EquipmentDefectiveAlert?: string | null;
+}
+/**
+ * CreateSsra
+ *
+ * @actionType CREATE - Creates a new SiteSpecificRiskAssessmentOutcomeForm record
+ * @module FieldServiceModule
+ * @entity SiteSpecificRiskAssessmentOutcomeForm
+ * @event k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra
+ * @permission schema.action.createssra.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+export declare class CreateSsraDto extends OdinRecordCreateDto<CreateSsraProperties> {
+    /** Used by SDK generators to identify action type */
+    static readonly ACTION_TYPE = "CREATE";
+    static readonly ACTION_KEY = "CreateSsra";
+    static readonly MODULE_NAME = "FieldServiceModule";
+    static readonly ENTITIES: string[];
+    static readonly EVENT_NAME = "k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra";
+    static readonly PERMISSION = "schema.action.createssra.trigger";
+    /** Step metadata - entity this action targets */
+    static readonly STEP_ENTITY = "FieldServiceModule:SiteSpecificRiskAssessmentOutcomeForm";
+    static readonly STEP_SCHEMA_ID = "6380e75c-a0cc-43e8-a57e-dabc00310d16";
+    static readonly STEP_SCHEMA_ACTION_ID = "a17ac2ef-f23e-4183-8aba-92ea3debd5fb";
+    static readonly AUTO_LINK_PARENT = true;
+    readonly actionName: string;
+    readonly schemaActionId: string;
+    readonly entity: string;
+    constructor(properties: CreateSsraProperties, options?: {
+        journeyId?: string;
+    });
+}

package/dist/actions-v2/CreateSsraDto.js

@@ -0,0 +1,50 @@
+"use strict";
+/**
+ * CreateSsra Action DTO
+ *
+ * @module FieldServiceModule
+ * @entity SiteSpecificRiskAssessmentOutcomeForm
+ * @actionKey CreateSsra
+ * @event k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateSsraDto = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * CreateSsra
+ *
+ * @actionType CREATE - Creates a new SiteSpecificRiskAssessmentOutcomeForm record
+ * @module FieldServiceModule
+ * @entity SiteSpecificRiskAssessmentOutcomeForm
+ * @event k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra
+ * @permission schema.action.createssra.trigger
+ * @benchmark This action is tracked for performance benchmarks
+ */
+class CreateSsraDto extends core_1.OdinRecordCreateDto {
+    constructor(properties, options) {
+        super({
+            entity: 'FieldServiceModule:SiteSpecificRiskAssessmentOutcomeForm',
+            type: undefined,
+            properties,
+            journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
+        });
+        this.actionName = 'CreateSsra';
+        this.schemaActionId = 'a17ac2ef-f23e-4183-8aba-92ea3debd5fb';
+        this.entity = 'FieldServiceModule:SiteSpecificRiskAssessmentOutcomeForm';
+    }
+}
+exports.CreateSsraDto = CreateSsraDto;
+/** Used by SDK generators to identify action type */
+CreateSsraDto.ACTION_TYPE = 'CREATE';
+CreateSsraDto.ACTION_KEY = 'CreateSsra';
+CreateSsraDto.MODULE_NAME = 'FieldServiceModule';
+CreateSsraDto.ENTITIES = ['SiteSpecificRiskAssessmentOutcomeForm'];
+CreateSsraDto.EVENT_NAME = 'k1.t-hEOJjsDb.FieldServiceModule.SiteSpecificRiskAssessmentOutcomeForm.Create.CreateSsra';
+CreateSsraDto.PERMISSION = 'schema.action.createssra.trigger';
+/** Step metadata - entity this action targets */
+CreateSsraDto.STEP_ENTITY = 'FieldServiceModule:SiteSpecificRiskAssessmentOutcomeForm';
+CreateSsraDto.STEP_SCHEMA_ID = '6380e75c-a0cc-43e8-a57e-dabc00310d16';
+CreateSsraDto.STEP_SCHEMA_ACTION_ID = 'a17ac2ef-f23e-4183-8aba-92ea3debd5fb';
+CreateSsraDto.AUTO_LINK_PARENT = true;