@d19n/youfibre-odin-sdk 1.0.235 → 1.0.237

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

@@ -20,7 +20,7 @@ export interface ActivateOrderProperties {
     /**
      * ActiveDate
      *
-     * active date
+     * active date (Sales - Order)
      * @type {DATE}
      * @required
      * @default Dynamic: {date_today}
@@ -30,7 +30,7 @@ export interface ActivateOrderProperties {
     /**
      * BillingStartDate
      *
-     * Billing start date
+     * Billing start date (Sales - Order)
      * @type {DATE}
      * @required
      * @default Dynamic: {date_today}
@@ -40,7 +40,7 @@ export interface ActivateOrderProperties {
     /**
      * DesiredBillingDay
      *
-     * Desired Billing Day
+     * Desired Billing Day (Sales - Order)
      * @type {NUMBER}
      */
     DesiredBillingDay?: number;

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

@@ -20,7 +20,7 @@ export interface AddressCreateProperties {
     /**
      * SPRN
      *
-     * sprn reference for Netomnia addresses
+     * sprn reference for Netomnia addresses (Sales - Address)
      * @type {NUMBER}
      * @required
      */
@@ -28,112 +28,112 @@ export interface AddressCreateProperties {
     /**
      * ExPolygonId
      *
-     * the id of the exchange polygon
+     * the id of the exchange polygon (Sales - Address)
      * @type {NUMBER}
      */
     ExPolygonId?: number;
     /**
      * Sales Status
      *
-     * The sales status for the address
+     * The sales status for the address (Sales - Address)
      * @type {ENUM}
      */
     SalesStatus?: string;
     /**
      * Address Line1
      *
-     * The first line of the contacts address.
+     * The first line of the contacts address. (Sales - Address)
      * @type {TEXT}
      */
     AddressLine1?: string;
     /**
      * Building Number
      *
-     * the building number for the address
+     * the building number for the address (Sales - Address)
      * @type {NUMBER}
      */
     BuildingNumber?: number;
     /**
      * Build Status
      *
-     * current build status for the area
+     * current build status for the area (Sales - Address)
      * @type {TEXT}
      */
     BuildStatus?: string;
     /**
      * City
      *
-     * The city of the contacts address.
+     * The city of the contacts address. (Sales - Address)
      * @type {TEXT}
      */
     City?: string;
     /**
      * Full Address
      *
-     * full address
+     * full address (Sales - Address)
      * @type {TEXT}
      */
     FullAddress?: string;
     /**
      * L1 Polygon Id
      *
-     * Id of the  l1 polygon
+     * Id of the  l1 polygon (Sales - Address)
      * @type {NUMBER}
      */
     L1PolygonId?: number;
     /**
      * L2 Polygon Id
      *
-     * the id of the l2 polygon
+     * the id of the l2 polygon (Sales - Address)
      * @type {NUMBER}
      */
     L2PolygonId?: number;
     /**
      * L4 Polygon Id
      *
-     * the id of the l4 polygon
+     * the id of the l4 polygon (Sales - Address)
      * @type {NUMBER}
      */
     L4PolygonId?: number;
     /**
      * LM Polygon Id
      *
-     * the id of the LM polygon (MDU properties)
+     * the id of the LM polygon (MDU properties) (Sales - Address)
      * @type {NUMBER}
      */
     LmPolygonId?: number;
     /**
      * Netomnia Sales Status
      *
-     * the sales status set by netmonia
+     * the sales status set by netmonia (Sales - Address)
      * @type {TEXT}
      */
     NetomniaSalesStatus?: string;
     /**
      * Postal Code
      *
-     * The postal code of the contacts address.
+     * The postal code of the contacts address. (Sales - Address)
      * @type {TEXT}
      */
     PostalCode?: string;
     /**
      * UDPRN
      *
-     * The Unique Delivery Point Reference Number
+     * The Unique Delivery Point Reference Number (Sales - Address)
      * @type {NUMBER}
      */
     Udprn?: number;
     /**
      * UMPRN
      *
-     * The Unique Multiple Premise Reference Number
+     * The Unique Multiple Premise Reference Number (Sales - Address)
      * @type {TEXT}
      */
     Umprn?: string;
     /**
      * UPRN
      *
-     * the uprn to identify the premise
+     * the uprn to identify the premise (Sales - Address)
      * @type {NUMBER}
      */
     Uprn?: number;

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

@@ -20,14 +20,14 @@ export interface AddressUpdateProperties {
     /**
      * Classification
      *
-     * the address classification from ab data
+     * the address classification from ab data (Sales - Address)
      * @type {TEXT}
      */
     Classification?: string;
     /**
      * SalesStatus
      *
-     * The sales status for the address
+     * The sales status for the address (Sales - Address)
      * @type {ENUM}
      */
     SalesStatus?: string;

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

@@ -21,14 +21,14 @@ export interface AssignCaseProperties {
     /**
      * Owner
      *
-     * Case owner
+     * Reference identifier for Case relationships. Used for data integrity.
      * @type {LOOKUP}
      */
     OwnerId?: string;
     /**
      * Team
      *
-     * Team
+     * Reference identifier for Case relationships. Used for data integrity.
      * @type {LOOKUP}
      */
     TeamId?: string;

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

@@ -22,14 +22,14 @@ export interface AssignCaseProperties {
     /**
      * Owner
      *
-     * Case owner
+     * Reference identifier for Case relationships. Used for data integrity.
      * @type {LOOKUP}
      */
     OwnerId?: string;
     /**
      * Team
      *
-     * Team
+     * Reference identifier for Case relationships. Used for data integrity.
      * @type {LOOKUP}
      */
     TeamId?: string;
@@ -85,7 +85,7 @@ export interface CreateNoteForCaseAssignmentProperties {
     /**
      * Body
      *
-     * body of the note
+     * body of the note (Customer Service - Note)
      * @type {TEXT_LONG}
      */
     Body?: string;

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

@@ -20,7 +20,7 @@ export interface AssignEngineerProperties {
     /**
      * engineer
      *
-     * engineer
+     * Reference identifier for WorkOrder relationships. Used for data integrity.
      * @type {LOOKUP}
      * @visibleWhen ScheduleIdDummy = ["*"]
      */
@@ -28,7 +28,7 @@ export interface AssignEngineerProperties {
     /**
      * Schedule Id Dummy
      *
-     * Dummy field for engineer assign schema action
+     * Dummy field for engineer assign schema action (Field Operations - WorkOrder)
      * @type {TEXT}
      * @default Dynamic: {source_record_properties_ScheduleId}
      * @hidden This field is not visible in the UI
@@ -37,7 +37,7 @@ export interface AssignEngineerProperties {
     /**
      * Schedule Id Alert
      *
-     * Shows when the assign engineer action is missing the schedule ID
+     * Shows when the assign engineer action is missing the schedule ID (Field Operations - WorkOrder)
      * @type {TEXT}
      * @visibleWhen ScheduleIdDummy = [null]
      */
@@ -55,7 +55,7 @@ export interface AssignEngineerProperties {
  * @riskLevel LOW
  * @decisionTier OPERATIONAL
  * @benchmark This action is tracked for performance benchmarks
- * @benchmarkTags assignment, field-operations, workorder
+ * @benchmarkTags action-type:assign, assignment, field-operations, workorder
  */
 export declare class AssignEngineerDto extends OdinRecordUpdateDto<AssignEngineerProperties> {
     /** Used by SDK generators to identify action type */

package/dist/actions-v2/AssignEngineerDto.js

@@ -25,7 +25,7 @@ const core_1 = require("@d19n/odin-types/dist/core");
  * @riskLevel LOW
  * @decisionTier OPERATIONAL
  * @benchmark This action is tracked for performance benchmarks
- * @benchmarkTags assignment, field-operations, workorder
+ * @benchmarkTags action-type:assign, assignment, field-operations, workorder
  */
 class AssignEngineerDto extends core_1.OdinRecordUpdateDto {
     constructor(record, properties, options) {

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

@@ -20,14 +20,14 @@ export interface AssignUsersProperties {
     /**
      * Supervisor Id
      *
-     * Supervisor (Regional)
+     * Supervisor (Regional) (Field Operations - ServiceAppointmentConfig)
      * @type {LOOKUP}
      */
     SupervisorId?: string;
     /**
      * Manager Id
      *
-     * Manager (Exchange level)
+     * Manager (Exchange level) (Field Operations - ServiceAppointmentConfig)
      * @type {LOOKUP}
      */
     ManagerId?: string;

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

@@ -20,14 +20,14 @@ export interface AssignWorkOrderProperties {
     /**
      * Team
      *
-     * The assigned team
+     * The assigned team (Field Operations - WorkOrder)
      * @type {LOOKUP}
      */
     TeamId?: string;
     /**
      * Owner
      *
-     * Owner
+     * Reference identifier for WorkOrder relationships. Used for data integrity.
      * @type {LOOKUP}
      */
     OwnerId?: string;

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

@@ -21,7 +21,7 @@ export interface CreateInstallCancelledChangeReasonSupplierProperties {
     /**
      * CancelReason
      *
-     * The reason of the cancellation
+     * The reason of the cancellation (Field Operations - ChangeReason)
      * @type {ENUM}
      * @required
      */
@@ -29,7 +29,7 @@ export interface CreateInstallCancelledChangeReasonSupplierProperties {
     /**
      * Owner
      *
-     * Owner (Supplier or Tenant)
+     * Owner (Supplier or Tenant) (Field Operations - ChangeReason)
      * @type {ENUM}
      * @default SUPPLIER
      * @hidden This field is not visible in the UI
@@ -38,7 +38,7 @@ export interface CreateInstallCancelledChangeReasonSupplierProperties {
     /**
      * Description
      *
-     * cancellation description
+     * cancellation description (Field Operations - ChangeReason)
      * @type {TEXT_LONG}
      */
     Description?: string;

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

@@ -21,7 +21,7 @@ export interface CreateInstallCancelledChangeReasonTenantProperties {
     /**
      * CancelReason
      *
-     * The reason of the cancellation
+     * The reason of the cancellation (Field Operations - ChangeReason)
      * @type {ENUM}
      * @required
      */
@@ -29,7 +29,7 @@ export interface CreateInstallCancelledChangeReasonTenantProperties {
     /**
      * Owner
      *
-     * Owner (Supplier or Tenant)
+     * Owner (Supplier or Tenant) (Field Operations - ChangeReason)
      * @type {ENUM}
      * @default TENANT
      * @hidden This field is not visible in the UI
@@ -38,7 +38,7 @@ export interface CreateInstallCancelledChangeReasonTenantProperties {
     /**
      * Description
      *
-     * cancellation description
+     * cancellation description (Field Operations - ChangeReason)
      * @type {TEXT_LONG}
      */
     Description?: string;

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

@@ -21,7 +21,7 @@ export interface CreatePrePullCancelledChangeReasonSupplierProperties {
     /**
      * CancelReason
      *
-     * The reason of the cancellation
+     * The reason of the cancellation (Field Operations - ChangeReason)
      * @type {ENUM}
      * @required
      */
@@ -29,7 +29,7 @@ export interface CreatePrePullCancelledChangeReasonSupplierProperties {
     /**
      * Owner
      *
-     * Owner (Supplier or Tenant)
+     * Owner (Supplier or Tenant) (Field Operations - ChangeReason)
      * @type {ENUM}
      * @default SUPPLIER
      * @hidden This field is not visible in the UI
@@ -38,7 +38,7 @@ export interface CreatePrePullCancelledChangeReasonSupplierProperties {
     /**
      * Description
      *
-     * cancellation description
+     * cancellation description (Field Operations - ChangeReason)
      * @type {TEXT_LONG}
      */
     Description?: string;

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

@@ -21,7 +21,7 @@ export interface CreateRemediationCancelledChangeReasonSupplierProperties {
     /**
      * CancelReason
      *
-     * The reason of the cancellation
+     * The reason of the cancellation (Field Operations - ChangeReason)
      * @type {ENUM}
      * @required
      */
@@ -29,7 +29,7 @@ export interface CreateRemediationCancelledChangeReasonSupplierProperties {
     /**
      * Owner
      *
-     * Owner (Supplier or Tenant)
+     * Owner (Supplier or Tenant) (Field Operations - ChangeReason)
      * @type {ENUM}
      * @default SUPPLIER
      * @hidden This field is not visible in the UI
@@ -38,7 +38,7 @@ export interface CreateRemediationCancelledChangeReasonSupplierProperties {
     /**
      * Description
      *
-     * cancellation description
+     * cancellation description (Field Operations - ChangeReason)
      * @type {TEXT_LONG}
      */
     Description?: string;

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

@@ -21,7 +21,7 @@ export interface CreateServiceCancelledChangeReasonSupplierProperties {
     /**
      * CancelReason
      *
-     * The reason of the cancellation
+     * The reason of the cancellation (Field Operations - ChangeReason)
      * @type {ENUM}
      * @required
      */
@@ -29,7 +29,7 @@ export interface CreateServiceCancelledChangeReasonSupplierProperties {
     /**
      * Owner
      *
-     * Owner (Supplier or Tenant)
+     * Owner (Supplier or Tenant) (Field Operations - ChangeReason)
      * @type {ENUM}
      * @default SUPPLIER
      * @hidden This field is not visible in the UI
@@ -38,7 +38,7 @@ export interface CreateServiceCancelledChangeReasonSupplierProperties {
     /**
      * Description
      *
-     * cancellation description
+     * cancellation description (Field Operations - ChangeReason)
      * @type {TEXT_LONG}
      */
     Description?: string;

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

@@ -21,7 +21,7 @@ export interface CreateServiceCancelledChangeReasonTenantProperties {
     /**
      * CancelReason
      *
-     * The reason of the cancellation
+     * The reason of the cancellation (Field Operations - ChangeReason)
      * @type {ENUM}
      * @required
      */
@@ -29,7 +29,7 @@ export interface CreateServiceCancelledChangeReasonTenantProperties {
     /**
      * Owner
      *
-     * Owner (Supplier or Tenant)
+     * Owner (Supplier or Tenant) (Field Operations - ChangeReason)
      * @type {ENUM}
      * @default TENANT
      * @hidden This field is not visible in the UI
@@ -38,7 +38,7 @@ export interface CreateServiceCancelledChangeReasonTenantProperties {
     /**
      * Description
      *
-     * cancellation description
+     * cancellation description (Field Operations - ChangeReason)
      * @type {TEXT_LONG}
      */
     Description?: string;

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

@@ -21,7 +21,7 @@ export interface CancelServiceWorkOrderTenantProperties {
     /**
      * cancellation reason
      *
-     * The reason of the cancellation
+     * The reason of the cancellation (Field Operations - ChangeReason)
      * @type {ENUM}
      * @required
      */

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

@@ -22,21 +22,21 @@ export interface CaseCreateNoteProperties {
     /**
      * Author
      *
-     * The author of the note
+     * The author of the note (Customer Service - Note)
      * @type {TEXT}
      */
     Author?: string;
     /**
      * Body
      *
-     * body of the note
+     * body of the note (Customer Service - Note)
      * @type {TEXT_LONG}
      */
     Body?: string;
     /**
      * Case
      *
-     * Case
+     * Data field for Note records. Used by Customer Service team.
      * @type {LOOKUP}
      */
     Case?: string;

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

@@ -22,7 +22,7 @@ export interface EscalateCaseActionProperties {
     /**
      * Team to Escalate To
      *
-     * Team
+     * Reference identifier for Case relationships. Used for data integrity.
      * @type {LOOKUP}
      * @required
      */
@@ -30,7 +30,7 @@ export interface EscalateCaseActionProperties {
     /**
      * OwnerId
      *
-     * Case owner
+     * Reference identifier for Case relationships. Used for data integrity.
      * @type {LOOKUP}
      * @hidden This field is not visible in the UI
      */
@@ -89,7 +89,7 @@ export interface CreateNoteForCaseAssignmentProperties {
     /**
      * Body
      *
-     * body of the note
+     * body of the note (Customer Service - Note)
      * @type {TEXT_LONG}
      */
     Body?: string;

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

@@ -22,7 +22,7 @@ export interface MoveCaseToBlockedActionProperties {
     /**
      * BlockedReason
      *
-     * Blocked Reason
+     * Blocked Reason (Customer Service - Case)
      * @type {ENUM}
      * @required
      */
@@ -30,7 +30,7 @@ export interface MoveCaseToBlockedActionProperties {
     /**
      * MoveToOpenOn
      *
-     * Date to re-open the case
+     * Date to re-open the case (Customer Service - Case)
      * @type {DATE}
      * @required
      */
@@ -38,7 +38,7 @@ export interface MoveCaseToBlockedActionProperties {
     /**
      * AdditionalNotes
      *
-     * Additional Notes
+     * Additional Notes (Customer Service - Case)
      * @type {TEXT_LONG}
      * @required
      */

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

@@ -20,7 +20,7 @@ export interface ChangeApprovalStatusProperties {
     /**
      * approval status
      *
-     * approval status
+     * approval status (Field Operations - PermissionToFail)
      * @type {ENUM}
      * @required
      */
@@ -28,7 +28,7 @@ export interface ChangeApprovalStatusProperties {
     /**
      * comment
      *
-     * comment when approving / rejecting
+     * comment when approving / rejecting (Field Operations - PermissionToFail)
      * @type {TEXT_LONG}
      * @required
      */

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

@@ -20,7 +20,7 @@ export interface ChangeBillingDayProperties {
     /**
      * billing day
      *
-     * Billing day in the month
+     * Billing day in the month (Sales - Order)
      * @type {NUMBER}
      * @required
      * @validWhen BillingDay lte ["28"]

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

@@ -21,14 +21,14 @@ export interface ChangeBillingModeProperties {
     /**
      * BillingMode
      *
-     * Controls how invoices are generated for this account. ORDER (default): each order generates its own invoice on its own billing cycle. ACCOUNT: all orders are consolidated into a single invoice on the account billing day.
+     * Controls how invoices are generated for this account. ORDER (default): each order generates its own invoice on its own billing cycle. ACCOUNT: all orders are consolidated into a single invoice on the account billing day. (Sales - Account)
      * @type {ENUM}
      */
     BillingMode?: string;
     /**
      * BillingDay
      *
-     * Day of month when consolidated invoices are generated. Required when BillingMode is ACCOUNT. Must be 1-28 to avoid end-of-month date issues.
+     * Day of month when consolidated invoices are generated. Required when BillingMode is ACCOUNT. Must be 1-28 to avoid end-of-month date issues. (Sales - Account)
      * @type {NUMBER}
      */
     BillingDay?: number;

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

@@ -21,7 +21,7 @@ export interface ChangeCaseChannelProperties {
     /**
      * Channel
      *
-     * the channel from the source
+     * the channel from the source (Customer Service - Case)
      * @type {ENUM}
      */
     Channel?: string;

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

@@ -21,7 +21,7 @@ export interface ChangeOntReplacementRequestApprovalStatusProperties {
     /**
      * approval status
      *
-     * if APPROVED it will remove the ONT from the order item
+     * if APPROVED it will remove the ONT from the order item (Field Operations - OntReplacementApproval)
      * @type {ENUM}
      */
     ApprovalStatus?: string;

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

@@ -20,35 +20,35 @@ export interface ChangeWorkOrderStatusProperties {
     /**
      * Status
      *
-     * Status
+     * Status indicator for WorkOrder records. Tracks lifecycle state. Used by Field Operations team.
      * @type {ENUM}
      */
     Status?: string;
     /**
      * Is VIP
      *
-     * Check if this is a VIP work order
+     * Check if this is a VIP work order (Field Operations - WorkOrder)
      * @type {BOOLEAN}
      */
     IsVip?: boolean;
     /**
      * confirmation status
      *
-     * tracks if the customer confirmed their scheduled appointment
+     * tracks if the customer confirmed their scheduled appointment (Field Operations - WorkOrder)
      * @type {ENUM}
      */
     ConfirmationStatus?: string;
     /**
      * Earlier Availability
      *
-     * Earlier Availability
+     * Earlier Availability (Field Operations - WorkOrder)
      * @type {BOOLEAN}
      */
     EarlierAvailability?: boolean;
     /**
      * SLA Override
      *
-     * Check this box to override the SLA
+     * Check this box to override the SLA (Field Operations - WorkOrder)
      * @type {BOOLEAN}
      */
     SlaOverride?: boolean;