@d19n/youfibre-odin-sdk 1.0.1

package/src/entities-v1/Visit.ts

@@ -0,0 +1,153 @@
+
+import { OdinPipelineStage, OdinGroup, OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/types/odin.types';
+
+import { AddressProperties } from './Address';
+import { LeadProperties } from './Lead';
+import { NoteProperties } from './Note';
+import { FileProperties } from './File';
+import { OrderProperties } from './Order';
+import { AppointmentProperties } from './Appointment';
+
+
+export enum VisitEntityTypes {
+	DEFAULT = 'DEFAULT',
+}
+
+
+export enum Outcome {
+	'CALL_COME_BACK_LATER' = 'COME_BACK_LATER',
+	'COMMUNICATION_CHALLENGE' = 'COMMUNICATION_CHALLENGE',
+	'DO_NOT_KNOCK' = 'DO_NOT_KNOCK',
+	'KNOCKED_NO_ANSWER' = 'KNOCKED_NO_ANSWER',
+	'LANDLORD_DECISION_REQUIRED' = 'LANDLORD_DECISSION_REQUIRED',
+	'NI_ALREADY_HAVE_FF' = 'NI_ALREADY_HAVE_FF',
+	'NI_HAPPY_WITH_PROVIDER' = 'NI_HAPPY_WITH_PROVIDER',
+	'NI_MOVING_HOME_NON_YF_AREA' = 'NI_MOVING_HOME',
+	'NI_NO_BUNDLE_OPTION' = 'NI_NO_BUNDLE_OPTION',
+	'NI_NO_REASON' = 'NI_NO_REASON',
+	'NI_OLDER_DEMOGRAPHIC' = 'NI_OLDER_DEMOGRAPHIC',
+	'NI_TOO_EXPENSIVE' = 'NI_TOO_EXPENSIVE',
+	'NO_ACCESS_TO_PROPERTY' = 'NO_ACCESS_TO_PROPERTY',
+	'NO_COLD_CALL_STICKER' = 'NO_COLD_CALL_STICKER',
+	'NOT_INTERESTED' = 'NOT_INTERESTED',
+	'VULNERABLE_PERSON' = 'VULNERABLE_PERSON',
+}
+export enum AgeBracket {
+	'18_30' = '18_30',
+	'30_50' = '30_50',
+	'50_65' = '50_65',
+}
+export enum NotInterestedReason {
+	'HAPPY_WITH_CURRENT_PROVIDER' = 'HAPPY_WITH_CURRENT_PROVIDER',
+	'MOVING_HOUSE_NON_YF_AREA' = 'MOVING_HOUSE',
+	'NO_BUNDLE_TV_SPORTS_ETC' = 'NO_BUNDLE',
+	'NO_REASON_GIVEN' = 'NO_REASON_GIVEN',
+	'OLDER_DEMOGRAPHIC' = 'OLDER_DEMOGRAPHIC',
+	'TOO_EXPENSIVE' = 'TOO_EXPENSIVE',
+}
+export enum Status {
+	'DONE' = 'DONE',
+	'TODO' = 'TODO',
+}
+export enum CurrentProvider {
+	'BT' = 'BT',
+	'CUCKOO' = 'CUCKOO',
+	'EE' = 'EE',
+	'OTHER' = 'OTHER',
+	'PLUSNET' = 'PLUSNET',
+	'SHELL' = 'SHELL',
+	'SKY' = 'SKY',
+	'TALK_TALK' = 'TALK_TALK',
+	'VIRGIN' = 'VIRGIN',
+	'VODAFONE' = 'VODAFONE',
+	'ZEN' = 'ZEN',
+}
+export enum DoNotKnockReason {
+	'DO_NOT_KNOCK_AREA' = 'DO_NOT_KNOCK_AREA',
+	'REQUESTED_NOT_TO_KNOCK' = 'REQUESTED_NOT_TO_KNOCK',
+	'VULNERABLE_PERSON' = 'VULNERABLE_PERSON',
+}
+export enum InterestedReason {
+	'CONSULTATION_WITH_PARTNER' = 'CONSULTATION_WITH_PARTNER',
+	'LEFT_INFORMATION' = 'LEFT_INFORMATION',
+	'NEEDS_TO_CHECK_CONTRACT' = 'NEEDS_TO_CHECK_CONTRACT',
+	'PITCHED_MISSED' = 'PITCHED_MISSED',
+}
+
+
+export enum VisitPropertyKeys {
+	FollowUpDate = 'FollowUpDate',
+	UDPRN = 'UDPRN',
+	UMPRN = 'UMPRN',
+	Outcome = 'Outcome',
+	L2PolygonId = 'L2PolygonId',
+	AgeBracket = 'AgeBracket',
+	NotInterestedReason = 'NotInterestedReason',
+	FullAddress = 'FullAddress',
+	Coordinates = 'Coordinates',
+	Status = 'Status',
+	DataSetId = 'DataSetId',
+	Longitude = 'Longitude',
+	Latitude = 'Latitude',
+	CurrentProvider = 'CurrentProvider',
+	ContractEndDate = 'ContractEndDate',
+	CurrentPrice = 'CurrentPrice',
+	DownloadSpeed = 'DownloadSpeed',
+	DoNotKnockReason = 'DoNotKnockReason',
+	InterestedReason = 'InterestedReason',
+	Comments = 'Comments',
+}
+
+  export interface VisitProperties {
+		FollowUpDate: Date
+		UDPRN: number
+		UMPRN: number
+		Outcome: Outcome
+		L2PolygonId: number
+		AgeBracket: AgeBracket
+		NotInterestedReason: NotInterestedReason
+		FullAddress: string
+		Coordinates: string
+		Status: Status
+		DataSetId: string
+		Longitude: string
+		Latitude: string
+		CurrentProvider: CurrentProvider
+		ContractEndDate: Date
+		CurrentPrice: number
+		DownloadSpeed: string
+		DoNotKnockReason: DoNotKnockReason
+		InterestedReason: InterestedReason
+		Comments: string
+		}
+
+  export interface Visit {
+		id: string
+		title: string
+		recordNumber: string
+		entity: 'CrmModule:Visit'
+		type: VisitEntityTypes
+		schemaTypeId: string
+		schemaId: 'ee544f3d-0c3b-4d71-bd8b-e5309a0a3c43'
+		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: VisitProperties,
+		Address: OdinLink<LinkedOdinRecord<AddressProperties>>,
+		Lead: OdinLink<LinkedOdinRecord<LeadProperties>>,
+		Note: OdinLink<LinkedOdinRecord<NoteProperties>>,
+		File: OdinLink<LinkedOdinRecord<FileProperties>>,
+		Order: OdinLink<LinkedOdinRecord<OrderProperties>>,
+		Appointment: OdinLink<LinkedOdinRecord<AppointmentProperties>>,
+}
+

package/src/entities-v1/VoiceConfiguration.ts

@@ -0,0 +1,175 @@
+
+import { OdinPipelineStage, OdinGroup, OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/types/odin.types';
+  
+import { OrderItemProperties } from './OrderItem';
+
+  
+export enum VoiceConfigurationEntityTypes {
+	DEFAULT = 'DEFAULT',
+}
+
+  
+export enum PortFromProvider {
+	'8X8_UK_LIMITED' = '496',
+	'AFFINITI_INTEGRATED_SOLUTIONS_LIMITED' = '029',
+	'AQL_WHOLESALE_LTD' = '093',
+	'BARRITEL_LIMITED' = '114',
+	'BICOM_SYSTEMS_EURL' = '423',
+	'BT' = '001',
+	'BUZZ_NETWORKS_LIMITED' = '023',
+	'CENTRAL_TECHNOLOGY_LIMITED' = '755',
+	'CLOUDCALL_LIMITED' = '610',
+	'COLT_TECHNOLOGY_SERVICES' = '040',
+	'DIAL_9_COMMUNICATIONS_LIMITED' = '842',
+	'DIGITAL_SPACE_GROUP_LIMITED' = '376',
+	'DRD_COMMUNICATIONS_LIMITED' = '217',
+	'EE' = '001_1',
+	'ESSENSYS_UK_LIMITED' = '678',
+	'FLE_XTEL_LIMITED' = '077',
+	'GAMMA_TELECOM_HOLDINGS_LTD' = '031',
+	'GCI_NETWORK_SOLUTIONS_LTD' = '711',
+	'GTT_EMEA_LTD' = '229',
+	'HELLO_TELECOM_UK_LIMITED' = '176',
+	'I_HUB_2_LIMITED' = '138',
+	'INCLARITY_COMMUNICATIONS_LIMITED' = '840',
+	'I_NET_COMMUNICATIONS_GROUP_PLC' = '475',
+	'INET_TELECOMS_LTD_VOIPFONE' = '184',
+	'INTRADO_CLOUD_SOLUTIONS_LIMITED' = '706',
+	'INVADE_INTERNATIONAL_LTD' = '198',
+	'INVOCO_LTD' = '266',
+	'IP_WHOLESALE_LIMITED' = '751',
+	'KALNET4_U_LTD' = '549',
+	'KCOM_GROUP_LIMITED' = '005',
+	'LIQUID_11_LIMITED' = '883',
+	'LOCALPHONE_LIMITED' = '886',
+	'LUMEN_TECHNOLOGIES_UK_LIMITED' = '804',
+	'MAGRATHEA_TELECOMMUNICATIONS_LIMITED' = '102',
+	'METRONET_UK_LIMITED' = '690',
+	'MICROTALK_EUROPE_LIMITED' = '801',
+	'MINTAKA_LIMITED' = '506',
+	'NATIONWIDE_TELEPHONE_ASSISTANCE_LTD' = '256',
+	'NEXBRIDGE_COMMUNICATIONS_LIMITED' = '397',
+	'NFON_UK_LTD' = '819',
+	'NODE4_LTD' = '213',
+	'NODEMAX_LIMITED' = '329',
+	'NOW_TV' = '822_1',
+	'NUMBERGROUP_UTILITIES_LTD' = '802',
+	'NUMBERS_PLUS_LTD' = '294',
+	'ORANGE_BUSINESS_HOLDINGS_UK_LIMITED' = '030',
+	'ORBITAL_NET_LIMITED' = '783',
+	'ORBTALK_LIMITED' = '588',
+	'OTHER' = 'other',
+	'PLUSNET' = '001_2',
+	'REALITY_NETWORK_SERVICES_LIMITED' = '123',
+	'REDCENTRIC_SOLUTIONS_LIMITED' = '055',
+	'RED_MATTER_LIMITED' = '615',
+	'REDWOOD_TECHNOLOGIES_LTD' = '723',
+	'RESILIENT_PLC' = '275',
+	'SHELL' = '820_2',
+	'SIMWOOD_E_SMS_LIMITED' = '498',
+	'SIX_DEGREES_TECHNOLOGY_GROUP_LIMITED' = '159',
+	'SKY_UK_LIMITED' = '822',
+	'SPITFIRE_NETWORK_SERVICES_LIMITED' = '356',
+	'SSE' = '820_1',
+	'STORACALL_TECHNOLOGY_LIMITED' = '487',
+	'SURETEC_SYSTEMS_LTD' = '291',
+	'SWIFTNET_LTD' = '354',
+	'SYNTEC_LIMITED' = '054',
+	'TALK_TALK_COMMUNICATIONS_LIMITED' = '820',
+	'TELECOM2_LIMITED' = '395',
+	'TELE_WARE_GROUP_PLC' = '369',
+	'TEL_XL_LTD' = '169',
+	'THE_EXCELL_GROUP_LIMITED' = '361',
+	'TIPICALL_LIMITED' = '680',
+	'VERIZON_UK_LIMITED' = '025',
+	'VIRGIN_MEDIA_LIMITED' = '825',
+	'VODAFONE' = 'other_1',
+	'VOICEFLEX_LIMITED' = '341',
+	'VOICE_HOST_LIMITED' = '537',
+	'VO_IP_UN_LIMITED' = '367',
+	'VOXBONE_SA' = '388',
+	'VOXYONDER_NETWORK_SERVICES_UK_LTD' = '890',
+	'WAVECREST_NETWORKS_LIMITED' = '860',
+	'WIGHTFIBRE_LIMITED' = '997',
+	'YAY_YAY_LIMITED' = '868',
+}
+  
+  
+export enum VoiceConfigurationPropertyKeys {
+	SystemMessageDate = 'SystemMessageDate',
+	VoicePortOperStatus = 'VoicePortOperStatus',
+	VoiceIp = 'VoiceIp',
+	VoicePortAdminStatus = 'VoicePortAdminStatus',
+	LastCheckStatusDate = 'LastCheckStatusDate',
+	VoiceServerStatus = 'VoiceServerStatus',
+	LastAction = 'LastAction',
+	PhoneNumberToPort = 'PhoneNumberToPort',
+	MagratheaOrderId = 'MagratheaOrderId',
+	VoiceLineState = 'VoiceLineState',
+	SipwiseCustomerId = 'SipwiseCustomerId',
+	SipwiseCustomerContactId = 'SipwiseCustomerContactId',
+	LastActionDate = 'LastActionDate',
+	IssuedPhoneNumber = 'IssuedPhoneNumber',
+	SipwiseSubscriberId = 'SipwiseSubscriberId',
+	IssuedPhoneNumberParts = 'IssuedPhoneNumberParts',
+	PortFromProvider = 'PortFromProvider',
+	MagratheaOrderStatusDate = 'MagratheaOrderStatusDate',
+	MagratheaOrderStatus = 'MagratheaOrderStatus',
+	PhoneNumberToPortParts = 'PhoneNumberToPortParts',
+	AuthorizedLOA = 'AuthorizedLOA',
+	OrderItemId = 'OrderItemId',
+	SystemMessage = 'SystemMessage',
+}
+
+  export interface VoiceConfigurationProperties {
+		SystemMessageDate: Date
+		VoicePortOperStatus: string
+		VoiceIp: string
+		VoicePortAdminStatus: string
+		LastCheckStatusDate: Date
+		VoiceServerStatus: string
+		LastAction: string
+		PhoneNumberToPort: string
+		MagratheaOrderId: string
+		VoiceLineState: string
+		SipwiseCustomerId: number
+		SipwiseCustomerContactId: number
+		LastActionDate: Date
+		IssuedPhoneNumber: string
+		SipwiseSubscriberId: number
+		IssuedPhoneNumberParts: string
+		PortFromProvider: PortFromProvider
+		MagratheaOrderStatusDate: Date
+		MagratheaOrderStatus: string
+		PhoneNumberToPortParts: string
+		AuthorizedLOA: boolean
+		OrderItemId: string
+		SystemMessage: string
+		}
+
+  export interface VoiceConfiguration {
+		id: string
+		title: string
+		recordNumber: string
+		entity: 'ServiceModule:VoiceConfiguration'
+		type: VoiceConfigurationEntityTypes
+		schemaTypeId: string
+		schemaId: 'c3aaff05-eb0d-43ec-b614-b71bfe7e5fe9'
+		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: VoiceConfigurationProperties,
+		OrderItem: OdinLink<LinkedOdinRecord<OrderItemProperties>>,
+}
+
+  

package/src/entities-v1/WayleaveServiceAppointmentConfig.ts

@@ -0,0 +1,156 @@
+
+  import { OdinPipelineStage, OdinGroup, OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/types/odin.types';
+  
+import { NoteProperties } from './Note';
+import { ServiceAppointmentProperties } from './ServiceAppointment';
+import { ScheduleSlotProperties } from './ScheduleSlot';
+import { WorkOrderProperties } from './WorkOrder';
+import { UserProperties } from './User';
+import { ChangeReasonProperties } from './ChangeReason';
+import { RegionProperties } from './Region';
+
+  
+export enum Contractor {
+	'360_NETWORKS' = '360_NETWORKS',
+	'C_L' = 'C&L',
+	'G_FORCE' = 'G_FORCE',
+	'GL_TELECOMS' = 'GL_TELECOMS',
+	'GNS' = 'GNS',
+	'KN_CIRCET' = 'KN_CIRCET',
+	'KN_NI' = 'KN_NI',
+	'LIGHT_SOURCE' = 'LIGHTSOURCE',
+	'MAP_GROUP' = 'MAP_GROUP',
+	'MJ_QUINN' = 'MJ_QUINN',
+	'NANO_FIBRE' = 'NANO_FIBRE',
+	'NETOMNIA' = 'NETOMNIA',
+	'NOVO' = 'NOVO',
+	'PICH' = 'PICH',
+	'S_M' = 'S&M',
+	'STL' = 'STL',
+	'YOU_FIBRE' = 'YOUFIBRE',
+}
+export enum Region {
+	'EAST' = 'EAST',
+	'EAST_MIDLANDS' = 'EAST_MIDLANDS',
+	'NORTH_EAST' = 'NORTH_EAST',
+	'NORTHERN_IRELAND' = 'NORTHERN_IRELAND',
+	'NORTH_WEST' = 'NORTH_WEST',
+	'SCOTLAND' = 'SCOTLAND',
+	'SOUTH_CENTRAL' = 'SOUTH_CENTRAL',
+	'SOUTH_EAST' = 'SOUTH_EAST',
+	'SOUTH_WEST' = 'SOUTH_WEST',
+	'WALES' = 'WALES',
+	'WEST_MIDLANDS' = 'WEST_MIDLANDS',
+	'YORKSHIRE_AND_THE_HUMBER' = 'YORKSHIRE_AND_THE_HUMBER',
+}
+export enum EnablePrePull {
+	'NO' = 'NO',
+	'YES' = 'YES',
+}
+  
+  
+  
+  
+  
+  
+export enum  WayleaveServiceAppointmentConfigPropertyKeys {
+	Friday_AM = 'Friday_AM',
+	Date = 'Date',
+	ExPolygonId = 'ExPolygonId',
+	Saturday_AM = 'Saturday_AM',
+	Thursday_PM = 'Thursday_PM',
+	Wednesday_AM = 'Wednesday_AM',
+	Monday_PM = 'Monday_PM',
+	PM = 'PM',
+	Friday_PM = 'Friday_PM',
+	Monday_AM = 'Monday_AM',
+	Saturday_PM = 'Saturday_PM',
+	Sunday_AM = 'Sunday_AM',
+	Sunday_PM = 'Sunday_PM',
+	Tuesday_PM = 'Tuesday_PM',
+	Wednesday_PM = 'Wednesday_PM',
+	Thursday_AM = 'Thursday_AM',
+	AM = 'AM',
+	IsDefault = 'IsDefault',
+	AvailableTo = 'AvailableTo',
+	Description = 'Description',
+	AvailableFrom = 'AvailableFrom',
+	Contractor = 'Contractor',
+	Region = 'Region',
+	BookingDelay = 'BookingDelay',
+	Tuesday_AM = 'Tuesday_AM',
+	MaxAdvanceBooking = 'MaxAdvanceBooking',
+	Priority = 'Priority',
+	AddressTypes = 'AddressTypes',
+	RegionId = 'RegionId',
+	SupervisorId = 'SupervisorId',
+	ManagerId = 'ManagerId',
+	EnablePrePull = 'EnablePrePull',
+}
+
+  export interface WayleaveServiceAppointmentConfigProperties {
+		Friday_AM: number
+		Date: Date
+		ExPolygonId: string
+		Saturday_AM: number
+		Thursday_PM: number
+		Wednesday_AM: number
+		Monday_PM: number
+		PM: number
+		Friday_PM: number
+		Monday_AM: number
+		Saturday_PM: number
+		Sunday_AM: number
+		Sunday_PM: number
+		Tuesday_PM: number
+		Wednesday_PM: number
+		Thursday_AM: number
+		AM: number
+		IsDefault: boolean
+		AvailableTo: Date
+		Description: string
+		AvailableFrom: Date
+		Contractor: Contractor
+		Region: Region
+		BookingDelay: number
+		Tuesday_AM: number
+		MaxAdvanceBooking: number
+		Priority: number
+		AddressTypes: string
+		RegionId: string
+		SupervisorId: string
+		ManagerId: string
+		EnablePrePull: EnablePrePull
+		}
+
+  export interface WayleaveServiceAppointmentConfig {
+		id: string
+		title: string
+		recordNumber: string
+		entity: 'FieldServiceModule:ServiceAppointmentConfig'
+		type: 'WAYLEAVE'
+		schemaTypeId: '0f55f60b-fc84-4677-a3e5-c7f8aac62bd7'
+		schemaId: 'e4804fe3-1e2e-49b6-adec-76ca69826919'
+		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: WayleaveServiceAppointmentConfigProperties,
+		Note: OdinLink<LinkedOdinRecord<NoteProperties>>,
+		ServiceAppointment: OdinLink<LinkedOdinRecord<ServiceAppointmentProperties>>,
+		ScheduleSlot: OdinLink<LinkedOdinRecord<ScheduleSlotProperties>>,
+		WorkOrder: OdinLink<LinkedOdinRecord<WorkOrderProperties>>,
+		User: OdinLink<LinkedOdinRecord<UserProperties>>,
+		ChangeReason: OdinLink<LinkedOdinRecord<ChangeReasonProperties>>,
+		Region: OdinLink<LinkedOdinRecord<RegionProperties>>,
+}
+