@vepler/sdk 2.131.2 → 2.137.0

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

@@ -0,0 +1,336 @@
+/*
+ * 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";
+
+/**
+ * Name of the consultee body.
+ */
+export type ConsulteeName = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Type of consultee. Statutory consultees are bodies the LPA must consult by law.
+ */
+export const PlanningConsulteeResponseValue = {
+  StatutoryConsultee: "statutory_consultee",
+  ParishCouncil: "parish_council",
+  WardMember: "ward_member",
+  HighwaysAuthority: "highways_authority",
+  EnvironmentAgency: "environment_agency",
+  HistoricEngland: "historic_england",
+  NaturalEngland: "natural_england",
+  FireService: "fire_service",
+  Police: "police",
+  LeadLocalFloodAuthority: "lead_local_flood_authority",
+  DesigningOutCrimeOfficer: "designing_out_crime_officer",
+  TreeOfficer: "tree_officer",
+  ConservationOfficer: "conservation_officer",
+  Other: "other",
+} as const;
+/**
+ * Type of consultee. Statutory consultees are bodies the LPA must consult by law.
+ */
+export type PlanningConsulteeResponseValue = OpenEnum<
+  typeof PlanningConsulteeResponseValue
+>;
+
+export type ConsulteeType = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  /**
+   * Type of consultee. Statutory consultees are bodies the LPA must consult by law.
+   */
+  value: PlanningConsulteeResponseValue;
+};
+
+export type KeyPoints = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * The consultee's stance.
+ */
+export const PlanningConsulteeResponseSchemasValue = {
+  Support: "support",
+  Object: "object",
+  NoObjection: "no_objection",
+  NoComment: "no_comment",
+  CommentOnly: "comment_only",
+  Conditional: "conditional",
+} as const;
+/**
+ * The consultee's stance.
+ */
+export type PlanningConsulteeResponseSchemasValue = OpenEnum<
+  typeof PlanningConsulteeResponseSchemasValue
+>;
+
+/**
+ * The consultee's overall stance.
+ */
+export type Position = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  /**
+   * The consultee's stance.
+   */
+  value: PlanningConsulteeResponseSchemasValue;
+};
+
+export type RaisedConcerns = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * ISO date (YYYY-MM-DD) the response was received. Null when not stated.
+ */
+export type ReceivedDate = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+export type SuggestedConditions = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+export type PlanningConsulteeResponse = {
+  /**
+   * Name of the consultee body.
+   */
+  consulteeName: ConsulteeName;
+  consulteeType: ConsulteeType;
+  /**
+   * Substantive points the consultee raised, each cited verbatim.
+   */
+  keyPoints: Array<KeyPoints>;
+  /**
+   * The consultee's overall stance.
+   */
+  position: Position;
+  /**
+   * Specific concerns the consultee flagged.
+   */
+  raisedConcerns: Array<RaisedConcerns>;
+  /**
+   * ISO date (YYYY-MM-DD) the response was received. Null when not stated.
+   */
+  receivedDate: ReceivedDate | null;
+  /**
+   * Conditions the consultee asked the LPA to impose.
+   */
+  suggestedConditions: Array<SuggestedConditions>;
+};
+
+/** @internal */
+export const ConsulteeName$inboundSchema: z.ZodType<
+  ConsulteeName,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function consulteeNameFromJSON(
+  jsonString: string,
+): SafeParseResult<ConsulteeName, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConsulteeName$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConsulteeName' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningConsulteeResponseValue$inboundSchema: z.ZodType<
+  PlanningConsulteeResponseValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningConsulteeResponseValue);
+
+/** @internal */
+export const ConsulteeType$inboundSchema: z.ZodType<
+  ConsulteeType,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: PlanningConsulteeResponseValue$inboundSchema,
+});
+
+export function consulteeTypeFromJSON(
+  jsonString: string,
+): SafeParseResult<ConsulteeType, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConsulteeType$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConsulteeType' from JSON`,
+  );
+}
+
+/** @internal */
+export const KeyPoints$inboundSchema: z.ZodType<
+  KeyPoints,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function keyPointsFromJSON(
+  jsonString: string,
+): SafeParseResult<KeyPoints, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => KeyPoints$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'KeyPoints' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningConsulteeResponseSchemasValue$inboundSchema: z.ZodType<
+  PlanningConsulteeResponseSchemasValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningConsulteeResponseSchemasValue);
+
+/** @internal */
+export const Position$inboundSchema: z.ZodType<
+  Position,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: PlanningConsulteeResponseSchemasValue$inboundSchema,
+});
+
+export function positionFromJSON(
+  jsonString: string,
+): SafeParseResult<Position, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Position$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Position' from JSON`,
+  );
+}
+
+/** @internal */
+export const RaisedConcerns$inboundSchema: z.ZodType<
+  RaisedConcerns,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function raisedConcernsFromJSON(
+  jsonString: string,
+): SafeParseResult<RaisedConcerns, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RaisedConcerns$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RaisedConcerns' from JSON`,
+  );
+}
+
+/** @internal */
+export const ReceivedDate$inboundSchema: z.ZodType<
+  ReceivedDate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function receivedDateFromJSON(
+  jsonString: string,
+): SafeParseResult<ReceivedDate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReceivedDate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReceivedDate' from JSON`,
+  );
+}
+
+/** @internal */
+export const SuggestedConditions$inboundSchema: z.ZodType<
+  SuggestedConditions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function suggestedConditionsFromJSON(
+  jsonString: string,
+): SafeParseResult<SuggestedConditions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SuggestedConditions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SuggestedConditions' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningConsulteeResponse$inboundSchema: z.ZodType<
+  PlanningConsulteeResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  consulteeName: z.lazy(() => ConsulteeName$inboundSchema),
+  consulteeType: z.lazy(() => ConsulteeType$inboundSchema),
+  keyPoints: z.array(z.lazy(() => KeyPoints$inboundSchema)),
+  position: z.lazy(() => Position$inboundSchema),
+  raisedConcerns: z.array(z.lazy(() => RaisedConcerns$inboundSchema)),
+  receivedDate: z.nullable(z.lazy(() => ReceivedDate$inboundSchema)),
+  suggestedConditions: z.array(z.lazy(() => SuggestedConditions$inboundSchema)),
+});
+
+export function planningConsulteeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningConsulteeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningConsulteeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningConsulteeResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,235 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ExtractionCitation,
+  ExtractionCitation$inboundSchema,
+} from "./extractioncitation.js";
+import {
+  PlanningConsulteeResponse,
+  PlanningConsulteeResponse$inboundSchema,
+} from "./planningconsulteeresponse.js";
+import {
+  PlanningRepresentationsBreakdown,
+  PlanningRepresentationsBreakdown$inboundSchema,
+} from "./planningrepresentationsbreakdown.js";
+
+/**
+ * ISO date (YYYY-MM-DD) the consultation ended. Null when not stated.
+ */
+export type ConsultationEndDate = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * ISO date (YYYY-MM-DD) the consultation began. Null when not stated.
+ */
+export type ConsultationStartDate = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Number of petitions received. Null when not stated.
+ */
+export type PetitionsReceived = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * Breakdown of public representations by stance. Null when not broken down.
+ */
+export type RepresentationsBreakdown = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: PlanningRepresentationsBreakdown;
+};
+
+/**
+ * Total public/neighbour representations received. Null when not stated.
+ */
+export type TotalRepresentations = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+export type PlanningConsulteeResponsesExtraction = {
+  /**
+   * ISO date (YYYY-MM-DD) the consultation ended. Null when not stated.
+   */
+  consultationEndDate: ConsultationEndDate | null;
+  /**
+   * ISO date (YYYY-MM-DD) the consultation began. Null when not stated.
+   */
+  consultationStartDate: ConsultationStartDate | null;
+  /**
+   * Number of petitions received. Null when not stated.
+   */
+  petitionsReceived: PetitionsReceived | null;
+  /**
+   * Breakdown of public representations by stance. Null when not broken down.
+   */
+  representationsBreakdown: RepresentationsBreakdown | null;
+  /**
+   * One entry per statutory consultee body that responded.
+   */
+  responses: Array<PlanningConsulteeResponse>;
+  /**
+   * Total public/neighbour representations received. Null when not stated.
+   */
+  totalRepresentations: TotalRepresentations | null;
+};
+
+/** @internal */
+export const ConsultationEndDate$inboundSchema: z.ZodType<
+  ConsultationEndDate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function consultationEndDateFromJSON(
+  jsonString: string,
+): SafeParseResult<ConsultationEndDate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConsultationEndDate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConsultationEndDate' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConsultationStartDate$inboundSchema: z.ZodType<
+  ConsultationStartDate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function consultationStartDateFromJSON(
+  jsonString: string,
+): SafeParseResult<ConsultationStartDate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConsultationStartDate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConsultationStartDate' from JSON`,
+  );
+}
+
+/** @internal */
+export const PetitionsReceived$inboundSchema: z.ZodType<
+  PetitionsReceived,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function petitionsReceivedFromJSON(
+  jsonString: string,
+): SafeParseResult<PetitionsReceived, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PetitionsReceived$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PetitionsReceived' from JSON`,
+  );
+}
+
+/** @internal */
+export const RepresentationsBreakdown$inboundSchema: z.ZodType<
+  RepresentationsBreakdown,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: PlanningRepresentationsBreakdown$inboundSchema,
+});
+
+export function representationsBreakdownFromJSON(
+  jsonString: string,
+): SafeParseResult<RepresentationsBreakdown, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RepresentationsBreakdown$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RepresentationsBreakdown' from JSON`,
+  );
+}
+
+/** @internal */
+export const TotalRepresentations$inboundSchema: z.ZodType<
+  TotalRepresentations,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function totalRepresentationsFromJSON(
+  jsonString: string,
+): SafeParseResult<TotalRepresentations, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TotalRepresentations$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TotalRepresentations' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningConsulteeResponsesExtraction$inboundSchema: z.ZodType<
+  PlanningConsulteeResponsesExtraction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  consultationEndDate: z.nullable(
+    z.lazy(() => ConsultationEndDate$inboundSchema),
+  ),
+  consultationStartDate: z.nullable(
+    z.lazy(() => ConsultationStartDate$inboundSchema),
+  ),
+  petitionsReceived: z.nullable(z.lazy(() => PetitionsReceived$inboundSchema)),
+  representationsBreakdown: z.nullable(
+    z.lazy(() => RepresentationsBreakdown$inboundSchema),
+  ),
+  responses: z.array(PlanningConsulteeResponse$inboundSchema),
+  totalRepresentations: z.nullable(
+    z.lazy(() => TotalRepresentations$inboundSchema),
+  ),
+});
+
+export function planningConsulteeResponsesExtractionFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningConsulteeResponsesExtraction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningConsulteeResponsesExtraction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningConsulteeResponsesExtraction' from JSON`,
+  );
+}

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

@@ -0,0 +1,131 @@
+/*
+ * 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 {
+  PlanningConsulteeResponsesExtraction,
+  PlanningConsulteeResponsesExtraction$inboundSchema,
+} from "./planningconsulteeresponsesextraction.js";
+
+/**
+ * The extractor's own confidence in this extraction.
+ */
+export const SelfConfidence = {
+  High: "high",
+  Medium: "medium",
+  Low: "low",
+} as const;
+/**
+ * The extractor's own confidence in this extraction.
+ */
+export type SelfConfidence = OpenEnum<typeof SelfConfidence>;
+
+/**
+ * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+ */
+export const PlanningConsulteeResponsesExtractionEnvelopeStatus = {
+  Extracted: "extracted",
+  Verified: "verified",
+} as const;
+/**
+ * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+ */
+export type PlanningConsulteeResponsesExtractionEnvelopeStatus = OpenEnum<
+  typeof PlanningConsulteeResponsesExtractionEnvelopeStatus
+>;
+
+/**
+ * Statutory consultee positions and the public-representations breakdown. Null when not available.
+ */
+export type PlanningConsulteeResponsesExtractionEnvelope = {
+  data: PlanningConsulteeResponsesExtraction;
+  /**
+   * ISO 8601 datetime the extraction was produced. Null when not recorded.
+   */
+  extractedAt: string | null;
+  /**
+   * Pipeline confidence score in the 0–1 range. Null when not scored.
+   */
+  modelConfidence: number | null;
+  /**
+   * Version of the extraction schema this payload conforms to.
+   */
+  schemaVersion: number;
+  /**
+   * The extractor's own confidence in this extraction.
+   */
+  selfConfidence: SelfConfidence;
+  /**
+   * ISO date (YYYY-MM-DD) the extraction was produced.
+   */
+  snapshotDate: string;
+  /**
+   * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+   */
+  status: PlanningConsulteeResponsesExtractionEnvelopeStatus;
+  /**
+   * Free-text note naming any ambiguity encountered, or null when confident.
+   */
+  uncertainty: string | null;
+  /**
+   * ISO 8601 datetime the extraction was verified. Null when not yet verified.
+   */
+  verifiedAt: string | null;
+};
+
+/** @internal */
+export const SelfConfidence$inboundSchema: z.ZodType<
+  SelfConfidence,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SelfConfidence);
+
+/** @internal */
+export const PlanningConsulteeResponsesExtractionEnvelopeStatus$inboundSchema:
+  z.ZodType<
+    PlanningConsulteeResponsesExtractionEnvelopeStatus,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    PlanningConsulteeResponsesExtractionEnvelopeStatus,
+  );
+
+/** @internal */
+export const PlanningConsulteeResponsesExtractionEnvelope$inboundSchema:
+  z.ZodType<
+    PlanningConsulteeResponsesExtractionEnvelope,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    data: PlanningConsulteeResponsesExtraction$inboundSchema,
+    extractedAt: z.nullable(z.string()),
+    modelConfidence: z.nullable(z.number()),
+    schemaVersion: z.number().int(),
+    selfConfidence: SelfConfidence$inboundSchema,
+    snapshotDate: z.string(),
+    status: PlanningConsulteeResponsesExtractionEnvelopeStatus$inboundSchema,
+    uncertainty: z.nullable(z.string()),
+    verifiedAt: z.nullable(z.string()),
+  });
+
+export function planningConsulteeResponsesExtractionEnvelopeFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PlanningConsulteeResponsesExtractionEnvelope,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningConsulteeResponsesExtractionEnvelope$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PlanningConsulteeResponsesExtractionEnvelope' from JSON`,
+  );
+}