@vepler/sdk 2.133.0 → 2.138.0

package/src/sdk/models/shared/planningofficerassessmentextraction.ts

@@ -0,0 +1,623 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ExtractionCitation,
+  ExtractionCitation$inboundSchema,
+} from "./extractioncitation.js";
+import {
+  PlanningPolicyRef,
+  PlanningPolicyRef$inboundSchema,
+} from "./planningpolicyref.js";
+import {
+  PlanningRepresentationsBreakdown,
+  PlanningRepresentationsBreakdown$inboundSchema,
+} from "./planningrepresentationsbreakdown.js";
+
+/**
+ * Case officer name or initials. Null when not stated.
+ */
+export type CaseOfficer = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * CIL liability in GBP. Null when not liable / not stated.
+ */
+export type CilAmountGBP = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * Whether the proposal is liable for Community Infrastructure Levy. Null when silent.
+ */
+export type CilLiable = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: boolean;
+};
+
+/**
+ * The 'Conclusion' / 'Planning Balance' final paragraph, cited verbatim. Null when no conclusion section.
+ */
+export type Conclusion = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * The officer's summary of consultee responses. Null when no consultees involved.
+ */
+export type ConsulteesSummary = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Whether the report includes a Public Sector Equality Duty assessment. Null when not addressed.
+ */
+export type EqualityImpactAssessed = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: boolean;
+};
+
+/**
+ * Whether the report includes a Habitats Regulations Assessment screening. Null when not addressed.
+ */
+export type HabitatRegsAssessed = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: boolean;
+};
+
+export type KeyIssues = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+export type PolicyRefs = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: PlanningPolicyRef;
+};
+
+/**
+ * The officer's summary of the proposal. Null when no clear summary section.
+ */
+export type ProposalSummary = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * The officer's summary of public representations. Null when none received.
+ */
+export type PublicResponseSummary = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Officer's formal recommendation.
+ */
+export const PlanningOfficerAssessmentExtractionValue = {
+  Grant: "grant",
+  GrantWithConditions: "grant_with_conditions",
+  Refuse: "refuse",
+  Defer: "defer",
+  NoRecommendation: "no_recommendation",
+} as const;
+/**
+ * Officer's formal recommendation.
+ */
+export type PlanningOfficerAssessmentExtractionValue = OpenEnum<
+  typeof PlanningOfficerAssessmentExtractionValue
+>;
+
+/**
+ * The officer's formal recommendation line.
+ */
+export type Recommendation = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  /**
+   * Officer's formal recommendation.
+   */
+  value: PlanningOfficerAssessmentExtractionValue;
+};
+
+/**
+ * ISO date (YYYY-MM-DD) of the report. Null when not stated.
+ */
+export type ReportDate = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Structured count of representations. Null when the report doesn't break down by stance.
+ */
+export type PlanningOfficerAssessmentExtractionRepresentationsBreakdown = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: PlanningRepresentationsBreakdown;
+};
+
+/**
+ * Whether an s106 agreement is required. Null when silent.
+ */
+export type S106Required = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: boolean;
+};
+
+export type PlanningOfficerAssessmentExtraction = {
+  /**
+   * Case officer name or initials. Null when not stated.
+   */
+  caseOfficer: CaseOfficer | null;
+  /**
+   * CIL liability in GBP. Null when not liable / not stated.
+   */
+  cilAmountGBP: CilAmountGBP | null;
+  /**
+   * Whether the proposal is liable for Community Infrastructure Levy. Null when silent.
+   */
+  cilLiable: CilLiable | null;
+  /**
+   * The 'Conclusion' / 'Planning Balance' final paragraph, cited verbatim. Null when no conclusion section.
+   */
+  conclusion: Conclusion | null;
+  /**
+   * The officer's summary of consultee responses. Null when no consultees involved.
+   */
+  consulteesSummary: ConsulteesSummary | null;
+  /**
+   * Whether the report includes a Public Sector Equality Duty assessment. Null when not addressed.
+   */
+  equalityImpactAssessed: EqualityImpactAssessed | null;
+  /**
+   * Whether the report includes a Habitats Regulations Assessment screening. Null when not addressed.
+   */
+  habitatRegsAssessed: HabitatRegsAssessed | null;
+  /**
+   * 'Key Issues' / 'Material Considerations' from the report, each cited verbatim.
+   */
+  keyIssues: Array<KeyIssues>;
+  /**
+   * Distinct policy citations in the report, deduplicated by code.
+   */
+  policyRefs: Array<PolicyRefs>;
+  /**
+   * The officer's summary of the proposal. Null when no clear summary section.
+   */
+  proposalSummary: ProposalSummary | null;
+  /**
+   * The officer's summary of public representations. Null when none received.
+   */
+  publicResponseSummary: PublicResponseSummary | null;
+  /**
+   * The officer's formal recommendation line.
+   */
+  recommendation: Recommendation;
+  /**
+   * ISO date (YYYY-MM-DD) of the report. Null when not stated.
+   */
+  reportDate: ReportDate | null;
+  /**
+   * Structured count of representations. Null when the report doesn't break down by stance.
+   */
+  representationsBreakdown:
+    | PlanningOfficerAssessmentExtractionRepresentationsBreakdown
+    | null;
+  /**
+   * Whether an s106 agreement is required. Null when silent.
+   */
+  s106Required: S106Required | null;
+};
+
+/** @internal */
+export const CaseOfficer$inboundSchema: z.ZodType<
+  CaseOfficer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function caseOfficerFromJSON(
+  jsonString: string,
+): SafeParseResult<CaseOfficer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CaseOfficer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CaseOfficer' from JSON`,
+  );
+}
+
+/** @internal */
+export const CilAmountGBP$inboundSchema: z.ZodType<
+  CilAmountGBP,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function cilAmountGBPFromJSON(
+  jsonString: string,
+): SafeParseResult<CilAmountGBP, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CilAmountGBP$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CilAmountGBP' from JSON`,
+  );
+}
+
+/** @internal */
+export const CilLiable$inboundSchema: z.ZodType<
+  CilLiable,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.boolean(),
+});
+
+export function cilLiableFromJSON(
+  jsonString: string,
+): SafeParseResult<CilLiable, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CilLiable$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CilLiable' from JSON`,
+  );
+}
+
+/** @internal */
+export const Conclusion$inboundSchema: z.ZodType<
+  Conclusion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function conclusionFromJSON(
+  jsonString: string,
+): SafeParseResult<Conclusion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Conclusion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Conclusion' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConsulteesSummary$inboundSchema: z.ZodType<
+  ConsulteesSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function consulteesSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<ConsulteesSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConsulteesSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConsulteesSummary' from JSON`,
+  );
+}
+
+/** @internal */
+export const EqualityImpactAssessed$inboundSchema: z.ZodType<
+  EqualityImpactAssessed,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.boolean(),
+});
+
+export function equalityImpactAssessedFromJSON(
+  jsonString: string,
+): SafeParseResult<EqualityImpactAssessed, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EqualityImpactAssessed$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EqualityImpactAssessed' from JSON`,
+  );
+}
+
+/** @internal */
+export const HabitatRegsAssessed$inboundSchema: z.ZodType<
+  HabitatRegsAssessed,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.boolean(),
+});
+
+export function habitatRegsAssessedFromJSON(
+  jsonString: string,
+): SafeParseResult<HabitatRegsAssessed, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HabitatRegsAssessed$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HabitatRegsAssessed' from JSON`,
+  );
+}
+
+/** @internal */
+export const KeyIssues$inboundSchema: z.ZodType<
+  KeyIssues,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function keyIssuesFromJSON(
+  jsonString: string,
+): SafeParseResult<KeyIssues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => KeyIssues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'KeyIssues' from JSON`,
+  );
+}
+
+/** @internal */
+export const PolicyRefs$inboundSchema: z.ZodType<
+  PolicyRefs,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: PlanningPolicyRef$inboundSchema,
+});
+
+export function policyRefsFromJSON(
+  jsonString: string,
+): SafeParseResult<PolicyRefs, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PolicyRefs$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PolicyRefs' from JSON`,
+  );
+}
+
+/** @internal */
+export const ProposalSummary$inboundSchema: z.ZodType<
+  ProposalSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function proposalSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<ProposalSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProposalSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProposalSummary' from JSON`,
+  );
+}
+
+/** @internal */
+export const PublicResponseSummary$inboundSchema: z.ZodType<
+  PublicResponseSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function publicResponseSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<PublicResponseSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PublicResponseSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PublicResponseSummary' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningOfficerAssessmentExtractionValue$inboundSchema: z.ZodType<
+  PlanningOfficerAssessmentExtractionValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningOfficerAssessmentExtractionValue);
+
+/** @internal */
+export const Recommendation$inboundSchema: z.ZodType<
+  Recommendation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: PlanningOfficerAssessmentExtractionValue$inboundSchema,
+});
+
+export function recommendationFromJSON(
+  jsonString: string,
+): SafeParseResult<Recommendation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Recommendation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Recommendation' from JSON`,
+  );
+}
+
+/** @internal */
+export const ReportDate$inboundSchema: z.ZodType<
+  ReportDate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function reportDateFromJSON(
+  jsonString: string,
+): SafeParseResult<ReportDate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReportDate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReportDate' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningOfficerAssessmentExtractionRepresentationsBreakdown$inboundSchema:
+  z.ZodType<
+    PlanningOfficerAssessmentExtractionRepresentationsBreakdown,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: PlanningRepresentationsBreakdown$inboundSchema,
+  });
+
+export function planningOfficerAssessmentExtractionRepresentationsBreakdownFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PlanningOfficerAssessmentExtractionRepresentationsBreakdown,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningOfficerAssessmentExtractionRepresentationsBreakdown$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'PlanningOfficerAssessmentExtractionRepresentationsBreakdown' from JSON`,
+  );
+}
+
+/** @internal */
+export const S106Required$inboundSchema: z.ZodType<
+  S106Required,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.boolean(),
+});
+
+export function s106RequiredFromJSON(
+  jsonString: string,
+): SafeParseResult<S106Required, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => S106Required$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'S106Required' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningOfficerAssessmentExtraction$inboundSchema: z.ZodType<
+  PlanningOfficerAssessmentExtraction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  caseOfficer: z.nullable(z.lazy(() => CaseOfficer$inboundSchema)),
+  cilAmountGBP: z.nullable(z.lazy(() => CilAmountGBP$inboundSchema)),
+  cilLiable: z.nullable(z.lazy(() => CilLiable$inboundSchema)),
+  conclusion: z.nullable(z.lazy(() => Conclusion$inboundSchema)),
+  consulteesSummary: z.nullable(z.lazy(() => ConsulteesSummary$inboundSchema)),
+  equalityImpactAssessed: z.nullable(
+    z.lazy(() => EqualityImpactAssessed$inboundSchema),
+  ),
+  habitatRegsAssessed: z.nullable(
+    z.lazy(() => HabitatRegsAssessed$inboundSchema),
+  ),
+  keyIssues: z.array(z.lazy(() => KeyIssues$inboundSchema)),
+  policyRefs: z.array(z.lazy(() => PolicyRefs$inboundSchema)),
+  proposalSummary: z.nullable(z.lazy(() => ProposalSummary$inboundSchema)),
+  publicResponseSummary: z.nullable(
+    z.lazy(() => PublicResponseSummary$inboundSchema),
+  ),
+  recommendation: z.lazy(() => Recommendation$inboundSchema),
+  reportDate: z.nullable(z.lazy(() => ReportDate$inboundSchema)),
+  representationsBreakdown: z.nullable(
+    z.lazy(() =>
+      PlanningOfficerAssessmentExtractionRepresentationsBreakdown$inboundSchema
+    ),
+  ),
+  s106Required: z.nullable(z.lazy(() => S106Required$inboundSchema)),
+});
+
+export function planningOfficerAssessmentExtractionFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningOfficerAssessmentExtraction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningOfficerAssessmentExtraction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningOfficerAssessmentExtraction' from JSON`,
+  );
+}