@planning-inspectorate/data-model 2.1.0 → 2.3.0

package/pins_data_model/models/model_appeal_s78.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-s78.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 
@@ -916,6 +916,10 @@ class AppealS78Case1(BaseModel):
     """
     A list of advertisements for the appeal
     """
+    padsSapId: str | None = None
+    """
+    padsSapId for PADS inspectors
+    """
 
 
 class AdvertDetail1(BaseModel):
@@ -1519,6 +1523,10 @@ class AppealS78Case2(BaseModel):
     """
     A list of advertisements for the appeal
     """
+    padsSapId: str | None = None
+    """
+    padsSapId for PADS inspectors
+    """
 
 
 class AppealS78Case(RootModel[AppealS78Case1 | AppealS78Case2]):

package/pins_data_model/models/model_dart_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  dart-response.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_entraid.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  entraid.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_folder.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  folder.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_gettimesheets_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  gettimesheets-response.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_listed_building.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  listed-building.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_listed_buildings.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  listed-buildings.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_document.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-document.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_exam_timetable.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-exam-timetable.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_invoice.py

@@ -0,0 +1,81 @@
+# generated by datamodel-codegen:
+#   filename:  nsip-invoice.schema.json
+#   timestamp: 2025-12-02T17:41:26+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class InvoiceStage(Enum):
+    """
+    Invoice stage
+    """
+
+    pre_acceptance = "pre_acceptance"
+    acceptance = "acceptance"
+    pre_examination = "pre_examination"
+    initial_examination = "initial_examination"
+    final_examination = "final_examination"
+    NoneType_None = None
+
+
+class NsipInvoice(BaseModel):
+    """
+    NSIP Standalone Invoice Schema for ODW Curated layer
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    caseId: int = Field(..., examples=[1242])
+    """
+    The unique identifier within the Back Office. This is not the same as the case reference
+    """
+    caseReference: str | None = Field(..., examples=["BC0510001"])
+    invoiceStage: InvoiceStage = Field(..., examples=["pre_acceptance"])
+    """
+    Invoice stage
+    """
+    invoiceNumber: str = Field(..., examples=["1800004419"])
+    """
+    Invoice number
+    """
+    amountDue: float = Field(..., examples=[500])
+    """
+    Amount due
+    """
+    paymentDueDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Payment due date
+    """
+    invoicedDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Invoiced date
+    """
+    paymentDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date of payment
+    """
+    refundCreditNoteNumber: str | None = Field(..., examples=["1800004419"])
+    """
+    Refund credit note number
+    """
+    refundAmount: float | None = Field(..., examples=[200])
+    """
+    Amount refunded
+    """
+    refundIssueDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Refund issue date
+    """

package/pins_data_model/models/model_nsip_meeting.py

@@ -0,0 +1,59 @@
+# generated by datamodel-codegen:
+#   filename:  nsip-meeting.schema.json
+#   timestamp: 2025-12-02T17:41:26+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class PlanningInspectorateRole(Enum):
+    """
+    Planning Inspectorate role
+    """
+
+    facilitator = "facilitator"
+    advisor = "advisor"
+    observer = "observer"
+    NoneType_None = None
+
+
+class NsipMeeting(BaseModel):
+    """
+    NSIP Standalone Meeting Schema for ODW Curated layer
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    meetingID: int = Field(..., examples=[1234])
+    """
+    The unique identifier for an NSIP Meeting.
+    """
+    caseId: int = Field(..., examples=[1242])
+    """
+    The unique identifier for the case within the Back Office. This is not the same as the case reference
+    """
+    caseReference: str | None = Field(..., examples=["BC0510001"])
+    meetingAgenda: str | None = Field(..., examples=["Flood Risk Assessment (FRA)"])
+    """
+    Meeting agenda
+    """
+    planningInspectorateRole: PlanningInspectorateRole = Field(
+        ..., examples=["facilitator"]
+    )
+    """
+    Planning Inspectorate role
+    """
+    meetingDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Meeting date
+    """
+    meetingType: str | None = None
+    """
+    Type of Meeting
+    """

package/pins_data_model/models/model_nsip_project.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_project_update.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project-update.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_representation.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-representation.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_subscription.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-subscription.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_pins_inspector.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  pins-inspector.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_pins_lpa.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  pins-lpa.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_s51_advice.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  s51-advice.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_service_user.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  service-user.schema.json
-#   timestamp: 2025-11-12T14:58:31+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/schemas/appeal-has.schema.json

@@ -72,7 +72,8 @@
     "neighbouringSiteAddresses",
     "affectedListedBuildingNumbers",
     "appellantCostsAppliedFor",
-    "lpaCostsAppliedFor"
+    "lpaCostsAppliedFor",
+    "padsSapId"
   ],
   "anyOf": [
     {
@@ -763,6 +764,10 @@
       },
       "description": "A list of advertisements for the appeal",
       "$comment": "Also available on CAS Adverts (ZA) cases"
+    },
+    "padsSapId": {
+      "type": ["string", "null"],
+      "description": "padsSapId for PADS inspectors"
     }
   }
 }

package/schemas/appeal-s78.schema.json

@@ -130,7 +130,8 @@
     "numberOfResidencesNetChange",
     "siteViewableFromRoad",
     "siteWithinSSSI",
-    "typeOfPlanningApplication"
+    "typeOfPlanningApplication",
+    "padsSapId"
   ],
   "anyOf": [
     {
@@ -1087,6 +1088,10 @@
       },
       "description": "A list of advertisements for the appeal",
       "$comment": "Also available on CAS Adverts (ZA) cases"
+    },
+    "padsSapId": {
+      "type": ["string", "null"],
+      "description": "padsSapId for PADS inspectors"
     }
   }
 }

package/schemas/nsip-invoice.schema.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "nsip-invoice.schema.json",
+  "title": "NSIP Invoice",
+  "description": "NSIP Standalone Invoice Schema for ODW Curated layer",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "caseId",
+    "caseReference",
+    "invoiceStage",
+    "invoiceNumber",
+    "amountDue",
+    "paymentDueDate",
+    "invoicedDate",
+    "paymentDate",
+    "refundCreditNoteNumber",
+    "refundAmount",
+    "refundIssueDate"
+  ],
+  "properties": {
+    "caseId": {
+      "type": "integer",
+      "examples": [1242],
+      "description": "The unique identifier within the Back Office. This is not the same as the case reference"
+    },
+    "caseReference": {
+      "type": ["string", "null"],
+      "examples": ["BC0510001"]
+    },
+    "invoiceStage": {
+      "type": ["string", "null"],
+      "description": "Invoice stage",
+      "enum": ["pre_acceptance", "acceptance", "pre_examination", "initial_examination", "final_examination", null],
+      "examples": ["pre_acceptance"]
+    },
+    "invoiceNumber": {
+      "type": "string",
+      "description": "Invoice number",
+      "examples": ["1800004419"]
+    },
+    "amountDue": {
+      "type": "number",
+      "description": "Amount due",
+      "examples": [500]
+    },
+    "paymentDueDate": {
+      "type": ["string", "null"],
+      "description": "Payment due date",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "invoicedDate": {
+      "type": ["string", "null"],
+      "description": "Invoiced date",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "paymentDate": {
+      "type": ["string", "null"],
+      "description": "Date of payment",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "refundCreditNoteNumber": {
+      "type": ["string", "null"],
+      "description": "Refund credit note number",
+      "examples": ["1800004419"]
+    },
+    "refundAmount": {
+      "type": ["number", "null"],
+      "description": "Amount refunded",
+      "examples": [200]
+    },
+    "refundIssueDate": {
+      "type": ["string", "null"],
+      "description": "Refund issue date",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    }
+  }
+}

package/schemas/nsip-meeting.schema.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "nsip-meeting.schema.json",
+  "title": "NSIP Meeting",
+  "description": "NSIP Standalone Meeting Schema for ODW Curated layer",
+  "type": "object",
+  "additionalProperties": true,
+
+  "required": [
+    "meetingID",
+    "caseId",
+    "caseReference",
+    "meetingAgenda",
+    "planningInspectorateRole",
+    "meetingDate",
+    "meetingType"
+  ],
+  "properties": {
+    "meetingID": {
+      "type": "integer",
+      "examples": [1234],
+      "description": "The unique identifier for an NSIP Meeting."
+    },
+    "caseId": {
+      "type": "integer",
+      "examples": [1242],
+      "description": "The unique identifier for the case within the Back Office. This is not the same as the case reference"
+    },
+    "caseReference": {
+      "type": ["string", "null"],
+      "examples": ["BC0510001"]
+    },
+    "meetingAgenda": {
+      "type": ["string", "null"],
+      "description": "Meeting agenda",
+      "examples": ["Flood Risk Assessment (FRA)"]
+    },
+    "planningInspectorateRole": {
+      "type": ["string", "null"],
+      "description": "Planning Inspectorate role",
+      "enum": ["facilitator", "advisor", "observer", null],
+      "examples": ["facilitator"]
+    },
+    "meetingDate": {
+      "type": ["string", "null"],
+      "description": "Meeting date",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "meetingType": {
+      "type": ["string", "null"],
+      "description": "Type of Meeting"
+    }
+  }
+}

package/src/enums.cjs

@@ -406,6 +406,14 @@ const NSIP_FAST_TRACK_ADMISSION_DOCUMENT = Object.freeze({
   SUBMITTED_BY_APPLICANT: 'submitted_by_applicant',
 });
 
+const NSIP_INVOICE_STAGE = Object.freeze({
+  ACCEPTANCE: 'acceptance',
+  FINAL_EXAMINATION: 'final_examination',
+  INITIAL_EXAMINATION: 'initial_examination',
+  PRE_ACCEPTANCE: 'pre_acceptance',
+  PRE_EXAMINATION: 'pre_examination',
+});
+
 const NSIP_LANGUAGE = Object.freeze({
   ENGLISH: 'English',
   WELSH: 'Welsh',
@@ -452,6 +460,12 @@ const NSIP_ORIGIN = Object.freeze({
   PINS: 'pins',
 });
 
+const NSIP_PLANNING_INSPECTORATE_ROLE = Object.freeze({
+  ADVISOR: 'advisor',
+  FACILITATOR: 'facilitator',
+  OBSERVER: 'observer',
+});
+
 const NSIP_POLICY_COMPLIANCE_DOCUMENT = Object.freeze({
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',
@@ -707,12 +721,14 @@ exports.NSIP_DECISION = NSIP_DECISION;
 exports.NSIP_DESIGN_APPROACH_DOCUMENT = NSIP_DESIGN_APPROACH_DOCUMENT;
 exports.NSIP_DOCUMENT_CASE_STAGE = NSIP_DOCUMENT_CASE_STAGE;
 exports.NSIP_FAST_TRACK_ADMISSION_DOCUMENT = NSIP_FAST_TRACK_ADMISSION_DOCUMENT;
+exports.NSIP_INVOICE_STAGE = NSIP_INVOICE_STAGE;
 exports.NSIP_LANGUAGE = NSIP_LANGUAGE;
 exports.NSIP_MAP_ZOOM_LEVEL = NSIP_MAP_ZOOM_LEVEL;
 exports.NSIP_MATURE_OUTLINE_CONTROL_DOCUMENT = NSIP_MATURE_OUTLINE_CONTROL_DOCUMENT;
 exports.NSIP_MULTIPARTY_APPLICATION_CHECK_DOCUMENT = NSIP_MULTIPARTY_APPLICATION_CHECK_DOCUMENT;
 exports.NSIP_NEW_MATURITY = NSIP_NEW_MATURITY;
 exports.NSIP_ORIGIN = NSIP_ORIGIN;
+exports.NSIP_PLANNING_INSPECTORATE_ROLE = NSIP_PLANNING_INSPECTORATE_ROLE;
 exports.NSIP_POLICY_COMPLIANCE_DOCUMENT = NSIP_POLICY_COMPLIANCE_DOCUMENT;
 exports.NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT = NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT;
 exports.NSIP_PROJECT_TYPE = NSIP_PROJECT_TYPE;

package/src/enums.d.ts

@@ -404,6 +404,14 @@ export const NSIP_FAST_TRACK_ADMISSION_DOCUMENT = {
   SUBMITTED_BY_APPLICANT: 'submitted_by_applicant',
 } as const;
 
+export const NSIP_INVOICE_STAGE = {
+  ACCEPTANCE: 'acceptance',
+  FINAL_EXAMINATION: 'final_examination',
+  INITIAL_EXAMINATION: 'initial_examination',
+  PRE_ACCEPTANCE: 'pre_acceptance',
+  PRE_EXAMINATION: 'pre_examination',
+} as const;
+
 export const NSIP_LANGUAGE = {
   ENGLISH: 'English',
   WELSH: 'Welsh',
@@ -450,6 +458,12 @@ export const NSIP_ORIGIN = {
   PINS: 'pins',
 } as const;
 
+export const NSIP_PLANNING_INSPECTORATE_ROLE = {
+  ADVISOR: 'advisor',
+  FACILITATOR: 'facilitator',
+  OBSERVER: 'observer',
+} as const;
+
 export const NSIP_POLICY_COMPLIANCE_DOCUMENT = {
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',

package/src/enums.js

@@ -404,6 +404,14 @@ export const NSIP_FAST_TRACK_ADMISSION_DOCUMENT = Object.freeze({
   SUBMITTED_BY_APPLICANT: 'submitted_by_applicant',
 });
 
+export const NSIP_INVOICE_STAGE = Object.freeze({
+  ACCEPTANCE: 'acceptance',
+  FINAL_EXAMINATION: 'final_examination',
+  INITIAL_EXAMINATION: 'initial_examination',
+  PRE_ACCEPTANCE: 'pre_acceptance',
+  PRE_EXAMINATION: 'pre_examination',
+});
+
 export const NSIP_LANGUAGE = Object.freeze({
   ENGLISH: 'English',
   WELSH: 'Welsh',
@@ -450,6 +458,12 @@ export const NSIP_ORIGIN = Object.freeze({
   PINS: 'pins',
 });
 
+export const NSIP_PLANNING_INSPECTORATE_ROLE = Object.freeze({
+  ADVISOR: 'advisor',
+  FACILITATOR: 'facilitator',
+  OBSERVER: 'observer',
+});
+
 export const NSIP_POLICY_COMPLIANCE_DOCUMENT = Object.freeze({
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',

package/src/index.cjs

@@ -487,6 +487,14 @@ const NSIP_FAST_TRACK_ADMISSION_DOCUMENT = Object.freeze({
   SUBMITTED_BY_APPLICANT: 'submitted_by_applicant',
 });
 
+const NSIP_INVOICE_STAGE = Object.freeze({
+  ACCEPTANCE: 'acceptance',
+  FINAL_EXAMINATION: 'final_examination',
+  INITIAL_EXAMINATION: 'initial_examination',
+  PRE_ACCEPTANCE: 'pre_acceptance',
+  PRE_EXAMINATION: 'pre_examination',
+});
+
 const NSIP_LANGUAGE = Object.freeze({
   ENGLISH: 'English',
   WELSH: 'Welsh',
@@ -533,6 +541,12 @@ const NSIP_ORIGIN = Object.freeze({
   PINS: 'pins',
 });
 
+const NSIP_PLANNING_INSPECTORATE_ROLE = Object.freeze({
+  ADVISOR: 'advisor',
+  FACILITATOR: 'facilitator',
+  OBSERVER: 'observer',
+});
+
 const NSIP_POLICY_COMPLIANCE_DOCUMENT = Object.freeze({
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',
@@ -820,12 +834,14 @@ exports.NSIP_DECISION = NSIP_DECISION;
 exports.NSIP_DESIGN_APPROACH_DOCUMENT = NSIP_DESIGN_APPROACH_DOCUMENT;
 exports.NSIP_DOCUMENT_CASE_STAGE = NSIP_DOCUMENT_CASE_STAGE;
 exports.NSIP_FAST_TRACK_ADMISSION_DOCUMENT = NSIP_FAST_TRACK_ADMISSION_DOCUMENT;
+exports.NSIP_INVOICE_STAGE = NSIP_INVOICE_STAGE;
 exports.NSIP_LANGUAGE = NSIP_LANGUAGE;
 exports.NSIP_MAP_ZOOM_LEVEL = NSIP_MAP_ZOOM_LEVEL;
 exports.NSIP_MATURE_OUTLINE_CONTROL_DOCUMENT = NSIP_MATURE_OUTLINE_CONTROL_DOCUMENT;
 exports.NSIP_MULTIPARTY_APPLICATION_CHECK_DOCUMENT = NSIP_MULTIPARTY_APPLICATION_CHECK_DOCUMENT;
 exports.NSIP_NEW_MATURITY = NSIP_NEW_MATURITY;
 exports.NSIP_ORIGIN = NSIP_ORIGIN;
+exports.NSIP_PLANNING_INSPECTORATE_ROLE = NSIP_PLANNING_INSPECTORATE_ROLE;
 exports.NSIP_POLICY_COMPLIANCE_DOCUMENT = NSIP_POLICY_COMPLIANCE_DOCUMENT;
 exports.NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT = NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT;
 exports.NSIP_PROJECT_TYPE = NSIP_PROJECT_TYPE;