@vepler/sdk 2.131.2 → 2.137.0

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

@@ -0,0 +1,136 @@
+/*
+ * 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 {
+  PlanningOfficerAssessmentExtraction,
+  PlanningOfficerAssessmentExtraction$inboundSchema,
+} from "./planningofficerassessmentextraction.js";
+
+/**
+ * The extractor's own confidence in this extraction.
+ */
+export const PlanningOfficerAssessmentExtractionEnvelopeSelfConfidence = {
+  High: "high",
+  Medium: "medium",
+  Low: "low",
+} as const;
+/**
+ * The extractor's own confidence in this extraction.
+ */
+export type PlanningOfficerAssessmentExtractionEnvelopeSelfConfidence =
+  OpenEnum<typeof PlanningOfficerAssessmentExtractionEnvelopeSelfConfidence>;
+
+/**
+ * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+ */
+export const PlanningOfficerAssessmentExtractionEnvelopeStatus = {
+  Extracted: "extracted",
+  Verified: "verified",
+} as const;
+/**
+ * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+ */
+export type PlanningOfficerAssessmentExtractionEnvelopeStatus = OpenEnum<
+  typeof PlanningOfficerAssessmentExtractionEnvelopeStatus
+>;
+
+/**
+ * The case officer's recommendation, key issues, policy refs, and CIL/s106 flags. Null when not available.
+ */
+export type PlanningOfficerAssessmentExtractionEnvelope = {
+  data: PlanningOfficerAssessmentExtraction;
+  /**
+   * 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: PlanningOfficerAssessmentExtractionEnvelopeSelfConfidence;
+  /**
+   * 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: PlanningOfficerAssessmentExtractionEnvelopeStatus;
+  /**
+   * 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 PlanningOfficerAssessmentExtractionEnvelopeSelfConfidence$inboundSchema:
+  z.ZodType<
+    PlanningOfficerAssessmentExtractionEnvelopeSelfConfidence,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    PlanningOfficerAssessmentExtractionEnvelopeSelfConfidence,
+  );
+
+/** @internal */
+export const PlanningOfficerAssessmentExtractionEnvelopeStatus$inboundSchema:
+  z.ZodType<
+    PlanningOfficerAssessmentExtractionEnvelopeStatus,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    PlanningOfficerAssessmentExtractionEnvelopeStatus,
+  );
+
+/** @internal */
+export const PlanningOfficerAssessmentExtractionEnvelope$inboundSchema:
+  z.ZodType<
+    PlanningOfficerAssessmentExtractionEnvelope,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    data: PlanningOfficerAssessmentExtraction$inboundSchema,
+    extractedAt: z.nullable(z.string()),
+    modelConfidence: z.nullable(z.number()),
+    schemaVersion: z.number().int(),
+    selfConfidence:
+      PlanningOfficerAssessmentExtractionEnvelopeSelfConfidence$inboundSchema,
+    snapshotDate: z.string(),
+    status: PlanningOfficerAssessmentExtractionEnvelopeStatus$inboundSchema,
+    uncertainty: z.nullable(z.string()),
+    verifiedAt: z.nullable(z.string()),
+  });
+
+export function planningOfficerAssessmentExtractionEnvelopeFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PlanningOfficerAssessmentExtractionEnvelope,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningOfficerAssessmentExtractionEnvelope$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PlanningOfficerAssessmentExtractionEnvelope' from JSON`,
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * 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";
+
+export type PlanningPolicyRef = {
+  /**
+   * Policy identifier as cited (e.g. 'NPPF para 11', 'Policy H5', 'Local Plan SP1').
+   */
+  code: string;
+  /**
+   * Brief description of what the policy covers. Null when only the code is cited.
+   */
+  description: string | null;
+};
+
+/** @internal */
+export const PlanningPolicyRef$inboundSchema: z.ZodType<
+  PlanningPolicyRef,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  description: z.nullable(z.string()),
+});
+
+export function planningPolicyRefFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningPolicyRef, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningPolicyRef$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningPolicyRef' from JSON`,
+  );
+}

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

@@ -10,6 +10,11 @@ import {
   PlanningQueryFilters$outboundSchema,
 } from "./planningqueryfilters.js";
 
+export const Include = {
+  Extractions: "extractions",
+} as const;
+export type Include = ClosedEnum<typeof Include>;
+
 /**
  * Field to sort results by. 'receivedDate' -- date the application was received by the council. 'validatedDate' -- date the application was formally validated. 'appealedDate' -- date an appeal was lodged. 'createdAt' -- date the record was created in our system. 'updatedAt' -- date the record was last updated in our system. Defaults to 'receivedDate'.
  */
@@ -42,6 +47,10 @@ export type PlanningQueryRequestSortOrder = ClosedEnum<
 >;
 
 export type PlanningQueryRequest = {
+  /**
+   * Optional expansions to attach to each returned application. 'extractions' attaches structured, citation-backed extractions (decision, development, s106, officer assessment, consultee responses). Omitted by default to keep responses lean — extractions are large. Request only when you need the detail (e.g. a handful of specific applications), not for bulk aggregation.
+   */
+  include?: Array<Include> | undefined;
   /**
    * Maximum number of applications to return per page. Must be between 1 and 100. Defaults to 50. Use together with offset for pagination.
    */
@@ -64,6 +73,10 @@ export type PlanningQueryRequest = {
   sortOrder?: PlanningQueryRequestSortOrder | undefined;
 };
 
+/** @internal */
+export const Include$outboundSchema: z.ZodNativeEnum<typeof Include> = z
+  .nativeEnum(Include);
+
 /** @internal */
 export const PlanningQueryRequestSortBy$outboundSchema: z.ZodNativeEnum<
   typeof PlanningQueryRequestSortBy
@@ -76,6 +89,7 @@ export const PlanningQueryRequestSortOrder$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type PlanningQueryRequest$Outbound = {
+  include?: Array<string> | undefined;
   limit: number;
   offset: number;
   query?: PlanningQueryFilters$Outbound | undefined;
@@ -89,6 +103,7 @@ export const PlanningQueryRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PlanningQueryRequest
 > = z.object({
+  include: z.array(Include$outboundSchema).optional(),
   limit: z.number().default(50),
   offset: z.number().default(0),
   query: PlanningQueryFilters$outboundSchema.optional(),

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

@@ -0,0 +1,44 @@
+/*
+ * 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";
+
+export type PlanningRepresentationsBreakdown = {
+  /**
+   * Number of neutral / comment-only representations.
+   */
+  neutral: number;
+  /**
+   * Number of representations objecting.
+   */
+  objections: number;
+  /**
+   * Number of representations in support.
+   */
+  support: number;
+};
+
+/** @internal */
+export const PlanningRepresentationsBreakdown$inboundSchema: z.ZodType<
+  PlanningRepresentationsBreakdown,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  neutral: z.number().int(),
+  objections: z.number().int(),
+  support: z.number().int(),
+});
+
+export function planningRepresentationsBreakdownFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningRepresentationsBreakdown, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningRepresentationsBreakdown$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningRepresentationsBreakdown' from JSON`,
+  );
+}

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

@@ -0,0 +1,246 @@
+/*
+ * 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 {
+  PlanningS106FinancialObligation,
+  PlanningS106FinancialObligation$inboundSchema,
+} from "./plannings106financialobligation.js";
+import {
+  PlanningS106NonFinancialObligation,
+  PlanningS106NonFinancialObligation$inboundSchema,
+} from "./plannings106nonfinancialobligation.js";
+import {
+  PlanningS106Party,
+  PlanningS106Party$inboundSchema,
+} from "./plannings106party.js";
+
+/**
+ * Application reference cited in the deed recitals. Null when the deed predates registration.
+ */
+export type ApplicationRef = {
+  /**
+   * 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 deed was executed. Null when not stated.
+ */
+export type DeedDate = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Whether any financial obligation is index-linked. Null when not addressed.
+ */
+export type HasIndexation = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: boolean;
+};
+
+/**
+ * Whether the deed contains a viability-review / recalculation clause. Null when not addressed.
+ */
+export type HasReviewMechanism = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: boolean;
+};
+
+/**
+ * Aggregate of all financial contributions where stated as a total. Null when no aggregate is given.
+ */
+export type TotalFinancialContributionGBP = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+export type PlanningS106Extraction = {
+  /**
+   * Application reference cited in the deed recitals. Null when the deed predates registration.
+   */
+  applicationRef: ApplicationRef | null;
+  /**
+   * ISO date (YYYY-MM-DD) the deed was executed. Null when not stated.
+   */
+  deedDate: DeedDate | null;
+  /**
+   * Every payment or financial contribution required by the deed.
+   */
+  financialObligations: Array<PlanningS106FinancialObligation>;
+  /**
+   * Whether any financial obligation is index-linked. Null when not addressed.
+   */
+  hasIndexation: HasIndexation | null;
+  /**
+   * Whether the deed contains a viability-review / recalculation clause. Null when not addressed.
+   */
+  hasReviewMechanism: HasReviewMechanism | null;
+  /**
+   * Every non-financial commitment (travel plan, tenure mix, phasing, etc.).
+   */
+  nonFinancialObligations: Array<PlanningS106NonFinancialObligation>;
+  /**
+   * All parties to the deed as listed in the recitals.
+   */
+  parties: Array<PlanningS106Party>;
+  /**
+   * Aggregate of all financial contributions where stated as a total. Null when no aggregate is given.
+   */
+  totalFinancialContributionGBP: TotalFinancialContributionGBP | null;
+};
+
+/** @internal */
+export const ApplicationRef$inboundSchema: z.ZodType<
+  ApplicationRef,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function applicationRefFromJSON(
+  jsonString: string,
+): SafeParseResult<ApplicationRef, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApplicationRef$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApplicationRef' from JSON`,
+  );
+}
+
+/** @internal */
+export const DeedDate$inboundSchema: z.ZodType<
+  DeedDate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function deedDateFromJSON(
+  jsonString: string,
+): SafeParseResult<DeedDate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeedDate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeedDate' from JSON`,
+  );
+}
+
+/** @internal */
+export const HasIndexation$inboundSchema: z.ZodType<
+  HasIndexation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.boolean(),
+});
+
+export function hasIndexationFromJSON(
+  jsonString: string,
+): SafeParseResult<HasIndexation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HasIndexation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HasIndexation' from JSON`,
+  );
+}
+
+/** @internal */
+export const HasReviewMechanism$inboundSchema: z.ZodType<
+  HasReviewMechanism,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.boolean(),
+});
+
+export function hasReviewMechanismFromJSON(
+  jsonString: string,
+): SafeParseResult<HasReviewMechanism, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HasReviewMechanism$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HasReviewMechanism' from JSON`,
+  );
+}
+
+/** @internal */
+export const TotalFinancialContributionGBP$inboundSchema: z.ZodType<
+  TotalFinancialContributionGBP,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function totalFinancialContributionGBPFromJSON(
+  jsonString: string,
+): SafeParseResult<TotalFinancialContributionGBP, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TotalFinancialContributionGBP$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TotalFinancialContributionGBP' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningS106Extraction$inboundSchema: z.ZodType<
+  PlanningS106Extraction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applicationRef: z.nullable(z.lazy(() => ApplicationRef$inboundSchema)),
+  deedDate: z.nullable(z.lazy(() => DeedDate$inboundSchema)),
+  financialObligations: z.array(PlanningS106FinancialObligation$inboundSchema),
+  hasIndexation: z.nullable(z.lazy(() => HasIndexation$inboundSchema)),
+  hasReviewMechanism: z.nullable(
+    z.lazy(() => HasReviewMechanism$inboundSchema),
+  ),
+  nonFinancialObligations: z.array(
+    PlanningS106NonFinancialObligation$inboundSchema,
+  ),
+  parties: z.array(PlanningS106Party$inboundSchema),
+  totalFinancialContributionGBP: z.nullable(
+    z.lazy(() => TotalFinancialContributionGBP$inboundSchema),
+  ),
+});
+
+export function planningS106ExtractionFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningS106Extraction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningS106Extraction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningS106Extraction' from JSON`,
+  );
+}

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

@@ -0,0 +1,124 @@
+/*
+ * 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 {
+  PlanningS106Extraction,
+  PlanningS106Extraction$inboundSchema,
+} from "./plannings106extraction.js";
+
+/**
+ * The extractor's own confidence in this extraction.
+ */
+export const PlanningS106ExtractionEnvelopeSelfConfidence = {
+  High: "high",
+  Medium: "medium",
+  Low: "low",
+} as const;
+/**
+ * The extractor's own confidence in this extraction.
+ */
+export type PlanningS106ExtractionEnvelopeSelfConfidence = OpenEnum<
+  typeof PlanningS106ExtractionEnvelopeSelfConfidence
+>;
+
+/**
+ * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+ */
+export const PlanningS106ExtractionEnvelopeStatus = {
+  Extracted: "extracted",
+  Verified: "verified",
+} as const;
+/**
+ * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+ */
+export type PlanningS106ExtractionEnvelopeStatus = OpenEnum<
+  typeof PlanningS106ExtractionEnvelopeStatus
+>;
+
+/**
+ * Section 106 financial and non-financial obligations. Null when not available.
+ */
+export type PlanningS106ExtractionEnvelope = {
+  data: PlanningS106Extraction;
+  /**
+   * 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: PlanningS106ExtractionEnvelopeSelfConfidence;
+  /**
+   * 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: PlanningS106ExtractionEnvelopeStatus;
+  /**
+   * 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 PlanningS106ExtractionEnvelopeSelfConfidence$inboundSchema:
+  z.ZodType<
+    PlanningS106ExtractionEnvelopeSelfConfidence,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(PlanningS106ExtractionEnvelopeSelfConfidence);
+
+/** @internal */
+export const PlanningS106ExtractionEnvelopeStatus$inboundSchema: z.ZodType<
+  PlanningS106ExtractionEnvelopeStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningS106ExtractionEnvelopeStatus);
+
+/** @internal */
+export const PlanningS106ExtractionEnvelope$inboundSchema: z.ZodType<
+  PlanningS106ExtractionEnvelope,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: PlanningS106Extraction$inboundSchema,
+  extractedAt: z.nullable(z.string()),
+  modelConfidence: z.nullable(z.number()),
+  schemaVersion: z.number().int(),
+  selfConfidence: PlanningS106ExtractionEnvelopeSelfConfidence$inboundSchema,
+  snapshotDate: z.string(),
+  status: PlanningS106ExtractionEnvelopeStatus$inboundSchema,
+  uncertainty: z.nullable(z.string()),
+  verifiedAt: z.nullable(z.string()),
+});
+
+export function planningS106ExtractionEnvelopeFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningS106ExtractionEnvelope, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningS106ExtractionEnvelope$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningS106ExtractionEnvelope' from JSON`,
+  );
+}