@d19n/youfibre-odin-sdk 1.0.1

package/src/entities-v1/OutcomeFormYfFieldServiceVisit.ts

@@ -0,0 +1,389 @@
+
+  import { OdinPipelineStage, OdinGroup, OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/types/odin.types';
+  
+import { FileProperties } from './File';
+import { NoteProperties } from './Note';
+
+  
+export enum SafeToEnter {
+	'N_A' = 'NA',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum AsbestosMaterials {
+	'N_A' = 'NA',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum RelevantTraining {
+	'N_A' = 'NA',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum WorkEnvironmentSafe {
+	'N_A' = 'NA',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum WorkingAreaFreeOfDangerousMaterials {
+	'N_A' = 'NA',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum AdultPresent {
+	'N_A' = 'NA',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum FireExits {
+	'N_A' = 'NA',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum FumesNotCreated {
+	'N_A' = 'NA',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum EngineerDiagnosis {
+	'CM_TRAINING' = 'CM_TRAINING',
+	'CONNECTION_DROP_OUTS' = 'CONNECTION_DROP_OUTS',
+	'EQUIPMENT_REPLACEMENT_FAULTY' = 'EQUIPMENT_REPLACEMENT_FAULTY',
+	'FIBRE_BREAK' = 'FIBRE_BREAK',
+	'FIBRE_DAMAGE_CM_FAULT' = 'FIBRE_DAMAGE_CM',
+	'FIBRE_ONT_RELOCATION' = 'FIBRE_RELOCATION',
+	'HARD_WIRE_DEVICES' = 'HARDWIRE_DEVICES',
+	'INSTALL_ADDITIONAL_MESH_NODE' = 'INSTALL_MESH',
+	'INSTALL_PHONE' = 'INSTALL_PHONE',
+	'NEW_INSTALL_SETUP' = 'NEW_INSTALL_SETUP',
+	'OTHER_DEVICE_CONNECTION' = 'OTHER_DEVICE_ISSUE',
+	'SLOW_SPEEDS' = 'SLOW_SPEEDS',
+	'TV_CONSOLE_PC_CONNECTION_PROBLEMS' = 'DEVICE_ISSUE',
+	'WI_FI_COVERAGE_ISSUE' = 'WIFI_COVERAGE_ISSUE',
+	'WI_FI_INTERFERENCE_ISSUE' = 'WIFI_INTERFERENCE_ISSUE',
+	'YOU_PHONE_ISSUE' = 'YOUPHONE_ISSUE',
+}
+export enum YouMeshCustomerBenefit {
+	'N_A' = 'NA',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum YouMeshCustomerOutcome {
+	'CUSTOMER_ACCEPTED' = 'CUSTOMER_ACCEPTED',
+	'CUSTOMER_DECLINED' = 'CUSTOMER_DECLINED',
+	'CUSTOMER_DEFERRED' = 'CUSTOMER_DEFERRED',
+}
+export enum YouPhoneCustomerBenefit {
+	'N_A' = 'NA',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum YouPhoneCustomerOutcome {
+	'CUSTOMER_ACCEPTED' = 'CUSTOMER_ACCEPTED',
+	'CUSTOMER_DECLINED' = 'CUSTOMER_DECLINED',
+	'CUSTOMER_DEFERRED' = 'CUSTOMER_DEFERRED',
+}
+export enum WhatAreYouReplacing1 {
+	'ARRIS_FAULTY' = 'ARRIS_FAULTY',
+	'EERO_FAULTY' = 'EERO_FAULTY',
+	'ONT_FAULTY' = 'ONT_FAULTY',
+}
+export enum CustomerOtherConcerns {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum YouMeshInstalledFirstTime {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum DeviceReport2 {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum OtherDeviceReport2 {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum YouPhoneReport3 {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum FaultResolvedEngineer {
+	'INSTALL_SETUP_REPLACEMENT' = 'Install / Setup / Replacement',
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum YouMeshConfirmation {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum HowManyYouMeshNodes {
+	'_1' = '1',
+	'_2' = '2',
+	'_3' = '3',
+	'_4' = '4',
+}
+export enum AbleToAchieveMinimumSpeed {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum AbleToAchieveSignal {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum NetworkSwitchesUse {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum NetworkSwitchesApproval {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum VisibleFibreBreak {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum SpeedTestConfirmation {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum WiFiAnalysisConfirmation {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum ConnectionCompletelyDown {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum EscalatedToManager {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+  
+  
+  
+  
+  
+  
+export enum  OutcomeFormYfFieldServiceVisitPropertyKeys {
+	DateTime = 'DateTime',
+	ServiceVisitDateTime = 'ServiceVisitDateTime',
+	EngineerNames = 'EngineerNames',
+	WorkOrderNumber = 'WorkOrderNumber',
+	Location = 'Location',
+	SafeToEnter = 'SafeToEnter',
+	AsbestosMaterials = 'AsbestosMaterials',
+	RelevantTraining = 'RelevantTraining',
+	WorkEnvironmentSafe = 'WorkEnvironmentSafe',
+	WorkEnvironmentUnsafe = 'WorkEnvironmentUnsafe',
+	WorkEnvironmentUnsafePhoto = 'WorkEnvironmentUnsafePhoto',
+	WorkingAreaFreeOfDangerousMaterials = 'WorkingAreaFreeOfDangerousMaterials',
+	AdultPresent = 'AdultPresent',
+	CantContinueVisit = 'CantContinueVisit',
+	FireExits = 'FireExits',
+	FumesNotCreated = 'FumesNotCreated',
+	RiskAssessmentConsent = 'RiskAssessmentConsent',
+	PreFaultInvestigationConsent = 'PreFaultInvestigationConsent',
+	EngineerDiagnosis = 'EngineerDiagnosis',
+	YouMeshCustomerBenefit = 'YouMeshCustomerBenefit',
+	YouMeshCustomerOutcome = 'YouMeshCustomerOutcome',
+	YouPhoneCustomerBenefit = 'YouPhoneCustomerBenefit',
+	YouPhoneCustomerOutcome = 'YouPhoneCustomerOutcome',
+	WhatAreYouReplacing1 = 'WhatAreYouReplacing1',
+	CustomerOtherConcerns = 'CustomerOtherConcerns',
+	OtherConcernsDescription = 'OtherConcernsDescription',
+	YouPhonePriceConfirmation = 'YouPhonePriceConfirmation',
+	YouMeshInstalledFirstTime = 'YouMeshInstalledFirstTime',
+	NetworkTopologyPhoto = 'NetworkTopologyPhoto',
+	WiFiSpeedTest = 'WiFiSpeedTest',
+	HardWireDevices = 'HardWireDevices',
+	WiFiSpeedTestWorstLocation = 'WiFiSpeedTestWorstLocation',
+	EX1Report1 = 'EX1Report1',
+	EX1Report2 = 'EX1Report2',
+	WiFiCoverageReport = 'WiFiCoverageReport',
+	WiFiInterferenceReport = 'WiFiInterferenceReport',
+	DeviceReport1 = 'DeviceReport1',
+	DeviceReport2 = 'DeviceReport2',
+	OtherDeviceReport1 = 'OtherDeviceReport1',
+	OtherDeviceReport2 = 'OtherDeviceReport2',
+	CMTraining = 'CMTraining',
+	YouPhoneReport1 = 'YouPhoneReport1',
+	YouPhoneReport2 = 'YouPhoneReport2',
+	YouPhoneReport3 = 'YouPhoneReport3',
+	YouPhoneEscalate = 'YouPhoneEscalate',
+	PostFaultInvestigationConsent = 'PostFaultInvestigationConsent',
+	FaultResolvedEngineer = 'FaultResolvedEngineer',
+	ONTLocationProperty = 'ONTLocationProperty',
+	RouterLocationProperty = 'RouterLocationProperty',
+	MainRouterSerial = 'MainRouterSerial',
+	YouMeshConfirmation = 'YouMeshConfirmation',
+	HowManyYouMeshNodes = 'HowManyYouMeshNodes',
+	YouMeshSerial1 = 'YouMeshSerial1',
+	YouMeshLocation1 = 'YouMeshLocation1',
+	YouMeshSerial2 = 'YouMeshSerial2',
+	YouMeshLocation2 = 'YouMeshLocation2',
+	YouMeshSerial3 = 'YouMeshSerial3',
+	YouMeshLocation3 = 'YouMeshLocation3',
+	YouMeshSerial4 = 'YouMeshSerial4',
+	YouMeshLocation4 = 'YouMeshLocation4',
+	AbleToAchieveMinimumSpeed = 'AbleToAchieveMinimumSpeed',
+	AbleToAchieveSignal = 'AbleToAchieveSignal',
+	NotAbleToAchieveSignalNote = 'NotAbleToAchieveSignalNote',
+	WiFiAnalysisConsent = 'WiFiAnalysisConsent',
+	EX1SpeedtestReport = 'EX1SpeedtestReport',
+	ResolutionNotes = 'ResolutionNotes',
+	NetworkSwitchesUse = 'NetworkSwitchesUse',
+	NetworkSwitchesApproval = 'NetworkSwitchesApproval',
+	NetworkSwitchesDenial = 'NetworkSwitchesDenial',
+	VisibleFibreBreak = 'VisibleFibreBreak',
+	SpeedTestConfirmation = 'SpeedTestConfirmation',
+	WiFiAnalysisConfirmation = 'WiFiAnalysisConfirmation',
+	ConnectionCompletelyDown = 'ConnectionCompletelyDown',
+	VisibleFibreBreakLocation = 'VisibleFibreBreakLocation',
+	AttemptedResolution = 'AttemptedResolution',
+	AdditionalNotes1 = 'AdditionalNotes1',
+	EscalatedToManager = 'EscalatedToManager',
+	WhatAreYouReplacing2 = 'WhatAreYouReplacing2',
+	Eero6Serial = 'Eero6Serial',
+	Eero6Photo = 'Eero6Photo',
+	Eero6ProSerial = 'Eero6ProSerial',
+	Eero6ProPhoto = 'Eero6ProPhoto',
+	EeroPro6ESerial = 'EeroPro6ESerial',
+	EeroPro6EPhoto = 'EeroPro6EPhoto',
+	NVG578LX1Serial = 'NVG578LX1Serial',
+	NVG578LX1Photo = 'NVG578LX1Photo',
+	NVG578LXSerial = 'NVG578LXSerial',
+	NVG578LXPhoto = 'NVG578LXPhoto',
+	X5042Serial = 'X5042Serial',
+	X5042Photo = 'X5042Photo',
+	AdditionalNotes2 = 'AdditionalNotes2',
+	SecondSpeedTest = 'SecondSpeedTest',
+	CustomerConfirmation = 'CustomerConfirmation',
+	CustomerSignature = 'CustomerSignature',
+	EngineerSignature = 'EngineerSignature',
+}
+
+  export interface OutcomeFormYfFieldServiceVisitProperties {
+		DateTime: Date
+		ServiceVisitDateTime: Date
+		EngineerNames: string
+		WorkOrderNumber: string
+		Location: string
+		SafeToEnter: SafeToEnter
+		AsbestosMaterials: AsbestosMaterials
+		RelevantTraining: RelevantTraining
+		WorkEnvironmentSafe: WorkEnvironmentSafe
+		WorkEnvironmentUnsafe: string
+		WorkEnvironmentUnsafePhoto: string
+		WorkingAreaFreeOfDangerousMaterials: WorkingAreaFreeOfDangerousMaterials
+		AdultPresent: AdultPresent
+		CantContinueVisit: boolean
+		FireExits: FireExits
+		FumesNotCreated: FumesNotCreated
+		RiskAssessmentConsent: boolean
+		PreFaultInvestigationConsent: boolean
+		EngineerDiagnosis: EngineerDiagnosis
+		YouMeshCustomerBenefit: YouMeshCustomerBenefit
+		YouMeshCustomerOutcome: YouMeshCustomerOutcome
+		YouPhoneCustomerBenefit: YouPhoneCustomerBenefit
+		YouPhoneCustomerOutcome: YouPhoneCustomerOutcome
+		WhatAreYouReplacing1: WhatAreYouReplacing1
+		CustomerOtherConcerns: CustomerOtherConcerns
+		OtherConcernsDescription: string
+		YouPhonePriceConfirmation: boolean
+		YouMeshInstalledFirstTime: YouMeshInstalledFirstTime
+		NetworkTopologyPhoto: string
+		WiFiSpeedTest: string
+		HardWireDevices: string
+		WiFiSpeedTestWorstLocation: string
+		EX1Report1: string
+		EX1Report2: string
+		WiFiCoverageReport: string
+		WiFiInterferenceReport: string
+		DeviceReport1: string
+		DeviceReport2: DeviceReport2
+		OtherDeviceReport1: string
+		OtherDeviceReport2: OtherDeviceReport2
+		CMTraining: string
+		YouPhoneReport1: string
+		YouPhoneReport2: string
+		YouPhoneReport3: YouPhoneReport3
+		YouPhoneEscalate: boolean
+		PostFaultInvestigationConsent: boolean
+		FaultResolvedEngineer: FaultResolvedEngineer
+		ONTLocationProperty: string
+		RouterLocationProperty: string
+		MainRouterSerial: string
+		YouMeshConfirmation: YouMeshConfirmation
+		HowManyYouMeshNodes: HowManyYouMeshNodes
+		YouMeshSerial1: string
+		YouMeshLocation1: string
+		YouMeshSerial2: string
+		YouMeshLocation2: string
+		YouMeshSerial3: string
+		YouMeshLocation3: string
+		YouMeshSerial4: string
+		YouMeshLocation4: string
+		AbleToAchieveMinimumSpeed: AbleToAchieveMinimumSpeed
+		AbleToAchieveSignal: AbleToAchieveSignal
+		NotAbleToAchieveSignalNote: string
+		WiFiAnalysisConsent: boolean
+		EX1SpeedtestReport: string
+		ResolutionNotes: string
+		NetworkSwitchesUse: NetworkSwitchesUse
+		NetworkSwitchesApproval: NetworkSwitchesApproval
+		NetworkSwitchesDenial: string
+		VisibleFibreBreak: VisibleFibreBreak
+		SpeedTestConfirmation: SpeedTestConfirmation
+		WiFiAnalysisConfirmation: WiFiAnalysisConfirmation
+		ConnectionCompletelyDown: ConnectionCompletelyDown
+		VisibleFibreBreakLocation: string
+		AttemptedResolution: string
+		AdditionalNotes1: string
+		EscalatedToManager: EscalatedToManager
+		WhatAreYouReplacing2: string
+		Eero6Serial: string
+		Eero6Photo: string
+		Eero6ProSerial: string
+		Eero6ProPhoto: string
+		EeroPro6ESerial: string
+		EeroPro6EPhoto: string
+		NVG578LX1Serial: string
+		NVG578LX1Photo: string
+		NVG578LXSerial: string
+		NVG578LXPhoto: string
+		X5042Serial: string
+		X5042Photo: string
+		AdditionalNotes2: string
+		SecondSpeedTest: string
+		CustomerConfirmation: boolean
+		CustomerSignature: string
+		EngineerSignature: string
+		}
+
+  export interface OutcomeFormYfFieldServiceVisit {
+		id: string
+		title: string
+		recordNumber: string
+		entity: 'FieldServiceModule:YfFieldServiceVisit'
+		type: 'OUTCOME_FORM'
+		schemaTypeId: '447a1913-aaaa-4b2c-934a-2147edab4163'
+		schemaId: '2cd2cbcb-b7bb-45db-8533-d71cba62ae99'
+		externalId: string
+		createdAt: Date
+		updatedAt: Date
+		deletedAt: Date
+		stageUpdatedAt: Date
+		createdBy: {id: string, fullName: string}
+		lastModifiedBy: {id: string, fullName: string}
+		stage: OdinPipelineStage
+		formattedProperties: Record<string, any>
+		groups: OdinGroup[]
+		isArchived: boolean
+		isLocked: boolean
+		links: {id: string, title: string[], entity: string}
+		properties: OutcomeFormYfFieldServiceVisitProperties,
+		File: OdinLink<LinkedOdinRecord<FileProperties>>,
+		Note: OdinLink<LinkedOdinRecord<NoteProperties>>,
+}
+  

package/src/entities-v1/OverlayRealA55.ts

@@ -0,0 +1,173 @@
+
+import { OdinPipelineStage, OdinGroup, OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/types/odin.types';
+  
+import { FileProperties } from './File';
+import { NoteProperties } from './Note';
+import { WorkOrderProperties } from './WorkOrder';
+
+  
+export enum OverlayRealA55EntityTypes {
+	OUTCOME_FORM = 'OUTCOME_FORM',
+}
+
+  
+export enum PointBLocation {
+	'CHAMBER' = 'CHAMBER',
+	'CUSTOMER_PROPERTY' = 'CUSTOMER_PROPERTY',
+	'POLE' = 'POLE',
+}
+export enum ChamberTypePointB {
+	'CW1_C_W_MANHOLE' = 'CW1',
+	'DUCT_MOUTH_AT_PROPERTY' = 'DUCT_MOUTH_AT_PROPERTY',
+	'HOLLOW_POLE' = 'HOLLOW_POLE',
+	'JRC12_C_W_2_LIDS' = 'JRC12',
+	'JRC14_C_W_3_LIDS' = 'JRC14',
+	'JUF10' = 'JUF10',
+	'JUF2' = 'JUF2',
+	'JUF4' = 'JUF4',
+	'JUF6' = 'JUF6',
+	'LOCKED_CHAMBER' = 'LOCKED_CHAMBER',
+	'M_H' = 'M/H',
+}
+export enum OverlayLocation {
+	'PRIVATE_LAND' = 'PRIVATE_LAND',
+	'PUBLIC_LAND' = 'PUBLIC_LAND',
+}
+export enum PointBTobyRequired {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum SurfaceType {
+	'HARD_TARMAC_PAVING' = 'HARD',
+	'SOFT_GRASS_SOIL' = 'SOFT',
+}
+export enum PointALocation {
+	'CHAMBER' = 'CHAMBER',
+	'CUSTOMER_PROPERTY' = 'CUSTOMER_PROPERTY',
+	'POLE' = 'POLE',
+}
+export enum ChamberTypePointA {
+	'CW1_C_W_MANHOLE' = 'CW1',
+	'DUCT_MOUTH_AT_PROPERTY' = 'DUCT_MOUTH_AT_PROPERTY',
+	'HOLLOW_POLE' = 'HOLLOW_POLE',
+	'JRC12_C_W_2_LIDS' = 'JRC12',
+	'JRC14_C_W_3_LIDS' = 'JRC14',
+	'JUF10' = 'JUF10',
+	'JUF2' = 'JUF2',
+	'JUF4' = 'JUF4',
+	'JUF6' = 'JUF6',
+	'LOCKED_CHAMBER' = 'LOCKED_CHAMBER',
+	'M_H' = 'M/H',
+}
+export enum MinimumFootwayDistanceMaintained {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum CarriagewayIncursionRequired {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+export enum PermissionsRequired {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+  
+  
+export enum OverlayRealA55PropertyKeys {
+	Overview = 'Overview',
+	DateCreated = 'DateCreated',
+	ExchangeName = 'ExchangeName',
+	EngineerName = 'EngineerName',
+	PointBLocation = 'PointBLocation',
+	ChamberTypePointB = 'ChamberTypePointB',
+	OverlayDetails = 'OverlayDetails',
+	OverlayLocation = 'OverlayLocation',
+	HowMuchOverlayRequired = 'HowMuchOverlayRequired',
+	OverlayRequiredPerspectiveViewPicture = 'OverlayRequiredPerspectiveViewPicture',
+	PointBTobyRequired = 'PointBTobyRequired',
+	PointBTobyLocation = 'PointBTobyLocation',
+	NetomniaOdinImageSuggestedRoute = 'NetomniaOdinImageSuggestedRoute',
+	UDPRN = 'UDPRN',
+	WorkOrderNumber = 'WorkOrderNumber',
+	FullAddress = 'FullAddress',
+	PIANOINumber = 'PIANOINumber',
+	SurfaceType = 'SurfaceType',
+	PointADetails = 'PointADetails',
+	PointALocation = 'PointALocation',
+	PointAImageSurrounding = 'PointAImageSurrounding',
+	PointAImageInternal = 'PointAImageInternal',
+	PointAImageRod = 'PointAImageRod',
+	PointAClosestAddress = 'PointAClosestAddress',
+	PointBDetails = 'PointBDetails',
+	ChamberTypePointA = 'ChamberTypePointA',
+	FurtherDetails = 'FurtherDetails',
+	MinimumFootwayDistanceMaintained = 'MinimumFootwayDistanceMaintained',
+	CarriagewayIncursionRequired = 'CarriagewayIncursionRequired',
+	CustomerInformation = 'CustomerInformation',
+	PermissionsRequired = 'PermissionsRequired',
+	PTDCopy = 'PTDCopy',
+}
+
+  export interface OverlayRealA55Properties {
+		Overview: string
+		DateCreated: Date
+		ExchangeName: string
+		EngineerName: string
+		PointBLocation: PointBLocation
+		ChamberTypePointB: ChamberTypePointB
+		OverlayDetails: string
+		OverlayLocation: OverlayLocation
+		HowMuchOverlayRequired: number
+		OverlayRequiredPerspectiveViewPicture: string
+		PointBTobyRequired: PointBTobyRequired
+		PointBTobyLocation: string
+		NetomniaOdinImageSuggestedRoute: string
+		UDPRN: string
+		WorkOrderNumber: string
+		FullAddress: string
+		PIANOINumber: string
+		SurfaceType: SurfaceType
+		PointADetails: string
+		PointALocation: PointALocation
+		PointAImageSurrounding: string
+		PointAImageInternal: string
+		PointAImageRod: string
+		PointAClosestAddress: string
+		PointBDetails: string
+		ChamberTypePointA: ChamberTypePointA
+		FurtherDetails: string
+		MinimumFootwayDistanceMaintained: MinimumFootwayDistanceMaintained
+		CarriagewayIncursionRequired: CarriagewayIncursionRequired
+		CustomerInformation: string
+		PermissionsRequired: PermissionsRequired
+		PTDCopy: string
+		}
+
+  export interface OverlayRealA55 {
+		id: string
+		title: string
+		recordNumber: string
+		entity: 'FieldServiceModule:OverlayRealA55'
+		type: OverlayRealA55EntityTypes
+		schemaTypeId: string
+		schemaId: 'fdceecf6-d629-4647-b9d5-4164f39bad78'
+		externalId: string
+		createdAt: Date
+		updatedAt: Date
+		deletedAt: Date
+		stageUpdatedAt: Date
+		createdBy: {id: string, fullName: string}
+		lastModifiedBy: {id: string, fullName: string}
+		stage: OdinPipelineStage
+		formattedProperties: Record<string, any>
+		groups: OdinGroup[]
+		isArchived: boolean
+		isLocked: boolean
+		links: {id: string, title: string[], entity: string}
+		properties: OverlayRealA55Properties,
+		File: OdinLink<LinkedOdinRecord<FileProperties>>,
+		Note: OdinLink<LinkedOdinRecord<NoteProperties>>,
+		WorkOrder: OdinLink<LinkedOdinRecord<WorkOrderProperties>>,
+}
+
+  

package/src/entities-v1/PICRequest.ts

@@ -0,0 +1,77 @@
+
+import { OdinPipelineStage, OdinGroup, OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/types/odin.types';
+  
+import { OrderProperties } from './Order';
+import { NoteProperties } from './Note';
+
+  
+export enum PICRequestEntityTypes {
+	DEFAULT = 'DEFAULT',
+}
+
+  
+export enum Reason {
+	'CUSTOMER_NOT_AGREED_INSTALL_ROUTE' = 'CUSTOMER_NOT_AGREED_INSTALL_ROUTE',
+	'CUSTOMER_SERVICE' = 'CUSTOMER_SERVICE',
+	'DECEASED' = 'DECEASED',
+	'INSTALLATION_DELAY_NETOMNIA' = 'INSTALLATION_DELAY_NETOMNIA',
+	'PERSONAL_REASONS' = 'CANCELLATION_FOR_PERSONAL_REASONS',
+	'REQUEST_TO_DELAY' = 'REQUEST_TO_DELAY',
+	'SALES_DUPLICATE_ORDER' = 'SALES_DUPLICATE_ORDER',
+	'SALES_INSTALL_NOT_BOOKED' = 'SALES_INSTALL_NOT_BOOKED',
+	'SALES_LOST_TO_COMPETITION' = 'SALES_LOST_TO_COMPETITION',
+	'SALES_MISSELLING' = 'SALES_MISSELLING',
+	'SALES_MOVE_OUT' = 'SALES_MOVE_OUT',
+	'SALES_OFFER_LAPSED_RE_SOLD' = 'SALES_OFFER_LAPSED',
+	'SALES_UNREACHABLE' = 'SALES_UNREACHABLE',
+	'UNINSTALLABLE_PROPERTY_NETOMNIA' = 'UNINSTALLABLE_PROPERTY',
+}
+export enum Outcome {
+	'LOST' = 'LOST',
+	'SAVED' = 'SAVED',
+}
+  
+  
+export enum PICRequestPropertyKeys {
+	Reason = 'Reason',
+	Comment = 'Comment',
+	CompletedBy = 'CompletedBy',
+	Outcome = 'Outcome',
+	CompletedDate = 'CompletedDate',
+}
+
+  export interface PICRequestProperties {
+		Reason: Reason
+		Comment: string
+		CompletedBy: string
+		Outcome: Outcome
+		CompletedDate: Date
+		}
+
+  export interface PICRequest {
+		id: string
+		title: string
+		recordNumber: string
+		entity: 'OrderModule:PICRequest'
+		type: PICRequestEntityTypes
+		schemaTypeId: string
+		schemaId: 'f00a6742-faa9-4f35-97a4-7f19f1673a95'
+		externalId: string
+		createdAt: Date
+		updatedAt: Date
+		deletedAt: Date
+		stageUpdatedAt: Date
+		createdBy: {id: string, fullName: string}
+		lastModifiedBy: {id: string, fullName: string}
+		stage: OdinPipelineStage
+		formattedProperties: Record<string, any>
+		groups: OdinGroup[]
+		isArchived: boolean
+		isLocked: boolean
+		links: {id: string, title: string[], entity: string}
+		properties: PICRequestProperties,
+		Order: OdinLink<LinkedOdinRecord<OrderProperties>>,
+		Note: OdinLink<LinkedOdinRecord<NoteProperties>>,
+}
+
+