@planning-inspectorate/data-model 2.49.0 → 2.51.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/README.md +23 -1
- package/docs/address.md +366 -0
- package/docs/applications-application-defs-address.md +108 -0
- package/docs/applications-application-defs-contact.md +98 -0
- package/docs/applications-application-defs-organisation.md +117 -0
- package/docs/applications-application-defs.md +3 -0
- package/docs/{application-update.md → applications-application-update.md} +22 -22
- package/docs/applications-application.md +2250 -0
- package/docs/applications-notify-email-defs-contact.md +93 -0
- package/docs/applications-notify-email-defs.md +3 -0
- package/docs/applications-notify-email.md +458 -0
- package/docs/applications-representation-definitions-contact.md +93 -0
- package/docs/applications-representation-definitions-representationdocument.md +152 -0
- package/docs/applications-representation-definitions.md +3 -0
- package/docs/applications-representation.md +834 -0
- package/docs/nsip-exam-timetable-defs-event.md +1 -0
- package/docs/nsip-exam-timetable.md +1 -0
- package/package.json +1 -1
- package/pins_data_model/gen_models.py +2 -1
- package/pins_data_model/models/model_address.py +69 -0
- package/pins_data_model/models/model_appeal_document.py +11 -11
- package/pins_data_model/models/model_appeal_event.py +4 -4
- package/pins_data_model/models/model_appeal_event_estimate.py +3 -3
- package/pins_data_model/models/model_appeal_has.py +111 -93
- package/pins_data_model/models/model_appeal_representation.py +12 -12
- package/pins_data_model/models/model_appeal_s78.py +246 -228
- package/pins_data_model/models/model_application_update.py +2 -2
- package/pins_data_model/models/model_applications_application.py +518 -0
- package/pins_data_model/models/model_applications_application_update.py +55 -0
- package/pins_data_model/models/model_applications_notify_email.py +124 -0
- package/pins_data_model/models/model_applications_representation.py +207 -0
- package/pins_data_model/models/model_dart_response.py +1 -1
- package/pins_data_model/models/model_folder.py +3 -3
- package/pins_data_model/models/model_nsip_document.py +12 -12
- package/pins_data_model/models/model_nsip_exam_timetable.py +3 -2
- package/pins_data_model/models/model_nsip_invoice.py +2 -2
- package/pins_data_model/models/model_nsip_project.py +19 -19
- package/pins_data_model/models/model_nsip_project_update.py +5 -5
- package/pins_data_model/models/model_nsip_representation.py +7 -7
- package/pins_data_model/models/model_nsip_subscription.py +6 -6
- package/pins_data_model/models/model_pins_inspector.py +5 -5
- package/pins_data_model/models/model_s51_advice.py +7 -7
- package/pins_data_model/models/model_service_user.py +2 -2
- package/requirements.txt +1 -1
- package/schemas/address.schema.json +87 -0
- package/schemas/{application-update.schema.json → applications-application-update.schema.json} +1 -1
- package/schemas/applications-application.schema.json +539 -0
- package/schemas/applications-notify-email.schema.json +118 -0
- package/schemas/applications-representation.schema.json +202 -0
- package/schemas/nsip-exam-timetable.schema.json +2 -1
- package/src/enums.cjs +147 -0
- package/src/enums.d.ts +131 -0
- package/src/enums.js +131 -0
- package/src/index.cjs +147 -0
- package/src/schemas.d.ts +680 -2
package/src/index.cjs
CHANGED
|
@@ -81,6 +81,13 @@ function loadSchemaSync(filePath) {
|
|
|
81
81
|
return jsoncParser.parse(content.toString());
|
|
82
82
|
}
|
|
83
83
|
|
|
84
|
+
const ADDRESS_TYPE = Object.freeze({
|
|
85
|
+
CONTACT: 'contact',
|
|
86
|
+
NEIGHBOURING: 'neighbouring',
|
|
87
|
+
ORGANISATION: 'organisation',
|
|
88
|
+
SITE: 'site',
|
|
89
|
+
});
|
|
90
|
+
|
|
84
91
|
const APPEAL_HAS_CASE_DECISION_OUTCOME = Object.freeze({
|
|
85
92
|
ALLOWED: 'allowed',
|
|
86
93
|
DISMISSED: 'dismissed',
|
|
@@ -518,12 +525,136 @@ const APPEAL_VIRUS_CHECK_STATUS = Object.freeze({
|
|
|
518
525
|
SCANNED: 'scanned',
|
|
519
526
|
});
|
|
520
527
|
|
|
528
|
+
const APPLICATION_STAGE = Object.freeze({
|
|
529
|
+
ACCEPTED: 'Accepted',
|
|
530
|
+
CONSULTATION: 'Consultation',
|
|
531
|
+
FINAL_DECISION: 'Final decision',
|
|
532
|
+
HEARING_INQUIRY_DATE_SET: 'Hearing/Inquiry date set',
|
|
533
|
+
INQUIRY: 'Inquiry',
|
|
534
|
+
PROCEDURE_CHOICE: 'Procedure choice',
|
|
535
|
+
WRITTEN_REPRESENTATIONS: 'Written representations',
|
|
536
|
+
});
|
|
537
|
+
|
|
538
|
+
const APPLICATION_STATUS = Object.freeze({
|
|
539
|
+
ACCEPTED: 'Accepted',
|
|
540
|
+
APPLICATION_ON_HOLD_AWAITING_FURTHER_INFORMATION: 'Application on hold awaiting further information',
|
|
541
|
+
CLOSED_INVALID: 'Closed - invalid',
|
|
542
|
+
CLOSED_OPENED_IN_ERROR: 'Closed - opened in error',
|
|
543
|
+
CONSULTATION_PERIOD_OPEN: 'Consultation period open',
|
|
544
|
+
DECIDED: 'Decided',
|
|
545
|
+
DECISION_AWAITED: 'Decision awaited',
|
|
546
|
+
DECLINED_TO_DETERMINE: 'Declined to determine',
|
|
547
|
+
HEARING_INQUIRY_DATE_SET: 'Hearing/Inquiry date set',
|
|
548
|
+
INVALID: 'Invalid',
|
|
549
|
+
NEW: 'New',
|
|
550
|
+
REPORT_AWAITED: 'Report awaited',
|
|
551
|
+
REPORT_SENT_TO_DECISION_BRANCH: 'Report sent to Decision Branch',
|
|
552
|
+
WITHDRAWN: 'Withdrawn',
|
|
553
|
+
});
|
|
554
|
+
|
|
521
555
|
const APPLICATION_UPDATE_STATUS = Object.freeze({
|
|
522
556
|
DRAFT: 'Draft',
|
|
523
557
|
PUBLISHED: 'Published',
|
|
524
558
|
UNPUBLISHED: 'Unpublished',
|
|
525
559
|
});
|
|
526
560
|
|
|
561
|
+
const APPLICATION_CATEGORY = Object.freeze({
|
|
562
|
+
BUILDINGS_LESS_THAN_1000_SQUARE_METRES: 'Buildings less than 1000 square metres',
|
|
563
|
+
BUILDINGS_OVER_1000_SQUARE_METRES: 'Buildings over 1000 square metres',
|
|
564
|
+
CHANGE_OF_USE: 'Change of use',
|
|
565
|
+
DEVELOPMENT_OF_A_SITE_ABOVE_1_HECTARE: 'Development of a site above 1 hectare',
|
|
566
|
+
DEVELOPMENT_OF_A_SITE_LESS_THAN_1_HECTARE: 'Development of a site less than 1 hectare',
|
|
567
|
+
DWELLINGS_NUMBERING_10_OR_MORE: 'Dwellings numbering 10 or more',
|
|
568
|
+
DWELLINGS_NUMBERING_BETWEEN_1_AND_9: 'Dwellings numbering between 1 and 9',
|
|
569
|
+
DWELLINGS_OF_0_5_HECTARE_OR_MORE: 'Dwellings of 0.5 hectare or more',
|
|
570
|
+
DWELLINGS_OF_LESS_THAN_0_5_HECTARE: 'Dwellings of less than 0.5 hectare',
|
|
571
|
+
LISTED_BUILDING_CONSENT_TO_ALTER_EXTEND: 'Listed building consent to alter/extend',
|
|
572
|
+
LISTED_BUILDING_CONSENT_TO_DEMOLISH: 'Listed building consent to demolish',
|
|
573
|
+
MAJOR_DEVELOPMENT: 'Major Development',
|
|
574
|
+
MINERALS: 'Minerals',
|
|
575
|
+
NON_MAJOR_DEVELOPMENT: 'Non-Major Development',
|
|
576
|
+
OTHER: 'Other',
|
|
577
|
+
RELEVANT_DEMOLITION: 'Relevant demolition',
|
|
578
|
+
WASTE: 'Waste',
|
|
579
|
+
});
|
|
580
|
+
|
|
581
|
+
const APPLICATION_DECISION_OUTCOME = Object.freeze({
|
|
582
|
+
APPROVED: 'Approved',
|
|
583
|
+
APPROVED_WITH_CONDITIONS: 'Approved with conditions',
|
|
584
|
+
REFUSED: 'Refused',
|
|
585
|
+
WITHDRAWN: 'Withdrawn',
|
|
586
|
+
});
|
|
587
|
+
|
|
588
|
+
const APPLICATION_EIA_SCREENING_OUTCOME = Object.freeze({
|
|
589
|
+
NOT_REQUIRED: 'not required',
|
|
590
|
+
REQUIRED: 'required',
|
|
591
|
+
});
|
|
592
|
+
|
|
593
|
+
const APPLICATION_EMAIL_STATUS = Object.freeze({
|
|
594
|
+
DELIVERED: 'Delivered',
|
|
595
|
+
PERMANENT_FAILURE: 'Permanent failure',
|
|
596
|
+
SENDING: 'Sending',
|
|
597
|
+
TECHNICAL_FAILURE: 'Technical failure',
|
|
598
|
+
TEMPORARY_FAILURE: 'Temporary failure',
|
|
599
|
+
});
|
|
600
|
+
|
|
601
|
+
const APPLICATION_PROCEDURE = Object.freeze({
|
|
602
|
+
HEARING: 'Hearing',
|
|
603
|
+
INQUIRY: 'Inquiry',
|
|
604
|
+
WRITTEN_REPRESENTATIONS: 'Written Representations',
|
|
605
|
+
});
|
|
606
|
+
|
|
607
|
+
const APPLICATION_REPRESENTATION_STATUS = Object.freeze({
|
|
608
|
+
ACCEPTED: 'Accepted',
|
|
609
|
+
AWAITING_REVIEW: 'Awaiting review',
|
|
610
|
+
REJECTED: 'Rejected',
|
|
611
|
+
WITHDRAWN: 'Withdrawn',
|
|
612
|
+
});
|
|
613
|
+
|
|
614
|
+
const APPLICATION_REPRESENTED_CATEGORY = Object.freeze({
|
|
615
|
+
CONSULTEES: 'Consultees',
|
|
616
|
+
INTERESTED_PARTY: 'Interested party',
|
|
617
|
+
});
|
|
618
|
+
|
|
619
|
+
const APPLICATION_REPRESENTED_TYPE = Object.freeze({
|
|
620
|
+
A_PERSON: 'A person',
|
|
621
|
+
AN_ORGANISATION_OR_CHARITY_I_DO_NOT_WORK_OR_VOLUNTEER_FOR: 'An organisation or charity I do not work or volunteer for',
|
|
622
|
+
AN_ORGANISATION_OR_CHARITY_I_WORK_OR_VOLUNTEER_FOR: 'An organisation or charity I work or volunteer for',
|
|
623
|
+
});
|
|
624
|
+
|
|
625
|
+
const APPLICATION_SUB_TYPE = Object.freeze({
|
|
626
|
+
LISTED_BUILDING_CONSENT_LBC: 'Listed building consent (LBC)',
|
|
627
|
+
PLANNING_PERMISSION: 'Planning permission',
|
|
628
|
+
});
|
|
629
|
+
|
|
630
|
+
const APPLICATION_SUBMITTED_FOR = Object.freeze({
|
|
631
|
+
MYSELF: 'Myself',
|
|
632
|
+
ON_BEHALF_OF_ANOTHER_PERSON_OR_AN_ORGANISATION: 'On behalf of another person or an organisation',
|
|
633
|
+
});
|
|
634
|
+
|
|
635
|
+
const APPLICATION_SUBMITTED_RECEIVED_METHOD = Object.freeze({
|
|
636
|
+
EMAIL: 'Email',
|
|
637
|
+
IN_PERSON: 'In person',
|
|
638
|
+
ONLINE: 'Online',
|
|
639
|
+
PHONE: 'Phone',
|
|
640
|
+
POST: 'Post',
|
|
641
|
+
});
|
|
642
|
+
|
|
643
|
+
const APPLICATION_TYPE = Object.freeze({
|
|
644
|
+
APPROVAL_OF_RESERVED_MATTERS_FOLLOWING_OUTLINE_APPROVAL: 'Approval of reserved matters following outline approval',
|
|
645
|
+
OUTLINE_PLANNING_PERMISSION_WITH_ALL_MATTERS_RESERVED: 'Outline planning permission with all matters reserved',
|
|
646
|
+
OUTLINE_PLANNING_PERMISSION_WITH_SOME_MATTERS_RESERVED: 'Outline planning permission with some matters reserved',
|
|
647
|
+
PLANNING_PERMISSION: 'Planning permission',
|
|
648
|
+
PLANNING_PERMISSION_AND_LISTED_BUILDING_CONSENT_LBC_FOR_ALTERATIONS_EXTENSION_OR_DEMOLITION_OF_A_LISTED_BUILDING: 'Planning permission and listed building consent (LBC) for alterations, extension or demolition of a listed building',
|
|
649
|
+
});
|
|
650
|
+
|
|
651
|
+
const APPLICATION_WITHDRAWAL_REASON = Object.freeze({
|
|
652
|
+
CHANGE_OF_OPINION: 'Change of opinion',
|
|
653
|
+
MISTAKEN_SUBMISSION: 'Mistaken Submission',
|
|
654
|
+
MISUNDERSTANDING: 'Misunderstanding',
|
|
655
|
+
PERSONAL_REASONS: 'Personal Reasons',
|
|
656
|
+
});
|
|
657
|
+
|
|
527
658
|
const CASE_STAGE = Object.freeze({
|
|
528
659
|
0: '0',
|
|
529
660
|
ACCEPTANCE: 'acceptance',
|
|
@@ -941,6 +1072,7 @@ function loadAllSchemasSync() {
|
|
|
941
1072
|
};
|
|
942
1073
|
}
|
|
943
1074
|
|
|
1075
|
+
exports.ADDRESS_TYPE = ADDRESS_TYPE;
|
|
944
1076
|
exports.APPEAL_ALLOCATION_LEVEL = APPEAL_ALLOCATION_LEVEL;
|
|
945
1077
|
exports.APPEAL_APPEAL_UNDER_ACT_SECTION = APPEAL_APPEAL_UNDER_ACT_SECTION;
|
|
946
1078
|
exports.APPEAL_APPELLANT_PROCEDURE_PREFERENCE = APPEAL_APPELLANT_PROCEDURE_PREFERENCE;
|
|
@@ -979,7 +1111,22 @@ exports.APPEAL_SOURCE_SYSTEM = APPEAL_SOURCE_SYSTEM;
|
|
|
979
1111
|
exports.APPEAL_TYPE_OF_PLANNING_APPLICATION = APPEAL_TYPE_OF_PLANNING_APPLICATION;
|
|
980
1112
|
exports.APPEAL_UNDER_ACT_SECTION = APPEAL_UNDER_ACT_SECTION;
|
|
981
1113
|
exports.APPEAL_VIRUS_CHECK_STATUS = APPEAL_VIRUS_CHECK_STATUS;
|
|
1114
|
+
exports.APPLICATION_CATEGORY = APPLICATION_CATEGORY;
|
|
1115
|
+
exports.APPLICATION_DECISION_OUTCOME = APPLICATION_DECISION_OUTCOME;
|
|
1116
|
+
exports.APPLICATION_EIA_SCREENING_OUTCOME = APPLICATION_EIA_SCREENING_OUTCOME;
|
|
1117
|
+
exports.APPLICATION_EMAIL_STATUS = APPLICATION_EMAIL_STATUS;
|
|
1118
|
+
exports.APPLICATION_PROCEDURE = APPLICATION_PROCEDURE;
|
|
1119
|
+
exports.APPLICATION_REPRESENTATION_STATUS = APPLICATION_REPRESENTATION_STATUS;
|
|
1120
|
+
exports.APPLICATION_REPRESENTED_CATEGORY = APPLICATION_REPRESENTED_CATEGORY;
|
|
1121
|
+
exports.APPLICATION_REPRESENTED_TYPE = APPLICATION_REPRESENTED_TYPE;
|
|
1122
|
+
exports.APPLICATION_STAGE = APPLICATION_STAGE;
|
|
1123
|
+
exports.APPLICATION_STATUS = APPLICATION_STATUS;
|
|
1124
|
+
exports.APPLICATION_SUBMITTED_FOR = APPLICATION_SUBMITTED_FOR;
|
|
1125
|
+
exports.APPLICATION_SUBMITTED_RECEIVED_METHOD = APPLICATION_SUBMITTED_RECEIVED_METHOD;
|
|
1126
|
+
exports.APPLICATION_SUB_TYPE = APPLICATION_SUB_TYPE;
|
|
1127
|
+
exports.APPLICATION_TYPE = APPLICATION_TYPE;
|
|
982
1128
|
exports.APPLICATION_UPDATE_STATUS = APPLICATION_UPDATE_STATUS;
|
|
1129
|
+
exports.APPLICATION_WITHDRAWAL_REASON = APPLICATION_WITHDRAWAL_REASON;
|
|
983
1130
|
exports.CASE_STAGE = CASE_STAGE;
|
|
984
1131
|
exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
|
|
985
1132
|
exports.METHOD = METHOD;
|