@vepler/sdk 2.131.2 → 2.137.0

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

@@ -0,0 +1,169 @@
+/*
+ * 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";
+
+/**
+ * Full text of the condition as written in the decision notice.
+ */
+export type Body = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * The 'Reason:' text accompanying the condition. Null when none given.
+ */
+export type Reason = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Stage at which a condition must be satisfied.
+ */
+export const PlanningDecisionConditionValue = {
+  PreCommencement: "pre_commencement",
+  PreOccupation: "pre_occupation",
+  Ongoing: "ongoing",
+  ComplianceWithPlans: "compliance_with_plans",
+  Other: "other",
+} as const;
+/**
+ * Stage at which a condition must be satisfied.
+ */
+export type PlanningDecisionConditionValue = OpenEnum<
+  typeof PlanningDecisionConditionValue
+>;
+
+/**
+ * When the condition is triggered. Null when ambiguous.
+ */
+export type TriggerStage = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  /**
+   * Stage at which a condition must be satisfied.
+   */
+  value: PlanningDecisionConditionValue;
+};
+
+export type PlanningDecisionCondition = {
+  /**
+   * Full text of the condition as written in the decision notice.
+   */
+  body: Body;
+  /**
+   * Sequential 1-indexed condition number as printed in the decision notice.
+   */
+  number: number;
+  /**
+   * The 'Reason:' text accompanying the condition. Null when none given.
+   */
+  reason: Reason | null;
+  /**
+   * When the condition is triggered. Null when ambiguous.
+   */
+  triggerStage: TriggerStage | null;
+};
+
+/** @internal */
+export const Body$inboundSchema: z.ZodType<Body, z.ZodTypeDef, unknown> = z
+  .object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: z.string(),
+  });
+
+export function bodyFromJSON(
+  jsonString: string,
+): SafeParseResult<Body, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Body$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Body' from JSON`,
+  );
+}
+
+/** @internal */
+export const Reason$inboundSchema: z.ZodType<Reason, z.ZodTypeDef, unknown> = z
+  .object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: z.string(),
+  });
+
+export function reasonFromJSON(
+  jsonString: string,
+): SafeParseResult<Reason, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Reason$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Reason' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningDecisionConditionValue$inboundSchema: z.ZodType<
+  PlanningDecisionConditionValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningDecisionConditionValue);
+
+/** @internal */
+export const TriggerStage$inboundSchema: z.ZodType<
+  TriggerStage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: PlanningDecisionConditionValue$inboundSchema,
+});
+
+export function triggerStageFromJSON(
+  jsonString: string,
+): SafeParseResult<TriggerStage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TriggerStage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TriggerStage' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningDecisionCondition$inboundSchema: z.ZodType<
+  PlanningDecisionCondition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  body: z.lazy(() => Body$inboundSchema),
+  number: z.number().int(),
+  reason: z.nullable(z.lazy(() => Reason$inboundSchema)),
+  triggerStage: z.nullable(z.lazy(() => TriggerStage$inboundSchema)),
+});
+
+export function planningDecisionConditionFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningDecisionCondition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningDecisionCondition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningDecisionCondition' from JSON`,
+  );
+}

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

@@ -0,0 +1,308 @@
+/*
+ * 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 {
+  PlanningDecisionCondition,
+  PlanningDecisionCondition$inboundSchema,
+} from "./planningdecisioncondition.js";
+
+/**
+ * Appeal-rights notice text from the decision notice. Null when not present.
+ */
+export type AppealRights = {
+  /**
+   * 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 decision was issued. Null when not stated.
+ */
+export type DecisionDate = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * How the decision was reached: delegated (officer authority), committee (planning committee), appeal (Planning Inspectorate), called_in (Secretary of State).
+ */
+export const PlanningDecisionExtractionValue = {
+  Delegated: "delegated",
+  Committee: "committee",
+  Appeal: "appeal",
+  CalledIn: "called_in",
+} as const;
+/**
+ * How the decision was reached: delegated (officer authority), committee (planning committee), appeal (Planning Inspectorate), called_in (Secretary of State).
+ */
+export type PlanningDecisionExtractionValue = OpenEnum<
+  typeof PlanningDecisionExtractionValue
+>;
+
+/**
+ * Decision-making route. Null when not stated.
+ */
+export type DecisionType = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  /**
+   * How the decision was reached: delegated (officer authority), committee (planning committee), appeal (Planning Inspectorate), called_in (Secretary of State).
+   */
+  value: PlanningDecisionExtractionValue;
+};
+
+/**
+ * Final outcome of the planning application.
+ */
+export const PlanningDecisionExtractionSchemasValue = {
+  Granted: "granted",
+  GrantedWithConditions: "granted_with_conditions",
+  Refused: "refused",
+  Withdrawn: "withdrawn",
+  SplitDecision: "split_decision",
+  NoDecisionRequired: "no_decision_required",
+} as const;
+/**
+ * Final outcome of the planning application.
+ */
+export type PlanningDecisionExtractionSchemasValue = OpenEnum<
+  typeof PlanningDecisionExtractionSchemasValue
+>;
+
+/**
+ * The decision outcome, cited from the formal decision notice.
+ */
+export type Outcome = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  /**
+   * Final outcome of the planning application.
+   */
+  value: PlanningDecisionExtractionSchemasValue;
+};
+
+export type RefusalReasons = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Years the permission is valid for (typically 3 full / 5 outline). Null when not stated.
+ */
+export type ValidityYears = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+export type PlanningDecisionExtraction = {
+  /**
+   * Appeal-rights notice text from the decision notice. Null when not present.
+   */
+  appealRights: AppealRights | null;
+  /**
+   * Every numbered condition attached to the decision. Empty when none imposed.
+   */
+  conditions: Array<PlanningDecisionCondition>;
+  /**
+   * ISO date (YYYY-MM-DD) the decision was issued. Null when not stated.
+   */
+  decisionDate: DecisionDate | null;
+  /**
+   * Decision-making route. Null when not stated.
+   */
+  decisionType: DecisionType | null;
+  /**
+   * The decision outcome, cited from the formal decision notice.
+   */
+  outcome: Outcome;
+  /**
+   * Numbered reasons for refusal, each cited verbatim. Empty unless refused.
+   */
+  refusalReasons: Array<RefusalReasons>;
+  /**
+   * Years the permission is valid for (typically 3 full / 5 outline). Null when not stated.
+   */
+  validityYears: ValidityYears | null;
+};
+
+/** @internal */
+export const AppealRights$inboundSchema: z.ZodType<
+  AppealRights,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function appealRightsFromJSON(
+  jsonString: string,
+): SafeParseResult<AppealRights, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppealRights$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppealRights' from JSON`,
+  );
+}
+
+/** @internal */
+export const DecisionDate$inboundSchema: z.ZodType<
+  DecisionDate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function decisionDateFromJSON(
+  jsonString: string,
+): SafeParseResult<DecisionDate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DecisionDate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DecisionDate' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningDecisionExtractionValue$inboundSchema: z.ZodType<
+  PlanningDecisionExtractionValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningDecisionExtractionValue);
+
+/** @internal */
+export const DecisionType$inboundSchema: z.ZodType<
+  DecisionType,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: PlanningDecisionExtractionValue$inboundSchema,
+});
+
+export function decisionTypeFromJSON(
+  jsonString: string,
+): SafeParseResult<DecisionType, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DecisionType$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DecisionType' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningDecisionExtractionSchemasValue$inboundSchema: z.ZodType<
+  PlanningDecisionExtractionSchemasValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningDecisionExtractionSchemasValue);
+
+/** @internal */
+export const Outcome$inboundSchema: z.ZodType<Outcome, z.ZodTypeDef, unknown> =
+  z.object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: PlanningDecisionExtractionSchemasValue$inboundSchema,
+  });
+
+export function outcomeFromJSON(
+  jsonString: string,
+): SafeParseResult<Outcome, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Outcome$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Outcome' from JSON`,
+  );
+}
+
+/** @internal */
+export const RefusalReasons$inboundSchema: z.ZodType<
+  RefusalReasons,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function refusalReasonsFromJSON(
+  jsonString: string,
+): SafeParseResult<RefusalReasons, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RefusalReasons$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RefusalReasons' from JSON`,
+  );
+}
+
+/** @internal */
+export const ValidityYears$inboundSchema: z.ZodType<
+  ValidityYears,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function validityYearsFromJSON(
+  jsonString: string,
+): SafeParseResult<ValidityYears, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ValidityYears$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ValidityYears' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningDecisionExtraction$inboundSchema: z.ZodType<
+  PlanningDecisionExtraction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  appealRights: z.nullable(z.lazy(() => AppealRights$inboundSchema)),
+  conditions: z.array(PlanningDecisionCondition$inboundSchema),
+  decisionDate: z.nullable(z.lazy(() => DecisionDate$inboundSchema)),
+  decisionType: z.nullable(z.lazy(() => DecisionType$inboundSchema)),
+  outcome: z.lazy(() => Outcome$inboundSchema),
+  refusalReasons: z.array(z.lazy(() => RefusalReasons$inboundSchema)),
+  validityYears: z.nullable(z.lazy(() => ValidityYears$inboundSchema)),
+});
+
+export function planningDecisionExtractionFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningDecisionExtraction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningDecisionExtraction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningDecisionExtraction' from JSON`,
+  );
+}

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

@@ -0,0 +1,126 @@
+/*
+ * 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 {
+  PlanningDecisionExtraction,
+  PlanningDecisionExtraction$inboundSchema,
+} from "./planningdecisionextraction.js";
+
+/**
+ * The extractor's own confidence in this extraction.
+ */
+export const PlanningDecisionExtractionEnvelopeSelfConfidence = {
+  High: "high",
+  Medium: "medium",
+  Low: "low",
+} as const;
+/**
+ * The extractor's own confidence in this extraction.
+ */
+export type PlanningDecisionExtractionEnvelopeSelfConfidence = OpenEnum<
+  typeof PlanningDecisionExtractionEnvelopeSelfConfidence
+>;
+
+/**
+ * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+ */
+export const PlanningDecisionExtractionEnvelopeStatus = {
+  Extracted: "extracted",
+  Verified: "verified",
+} as const;
+/**
+ * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+ */
+export type PlanningDecisionExtractionEnvelopeStatus = OpenEnum<
+  typeof PlanningDecisionExtractionEnvelopeStatus
+>;
+
+/**
+ * Decision outcome, conditions, and refusal reasons from the decision notice. Null when not available.
+ */
+export type PlanningDecisionExtractionEnvelope = {
+  data: PlanningDecisionExtraction;
+  /**
+   * 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: PlanningDecisionExtractionEnvelopeSelfConfidence;
+  /**
+   * 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: PlanningDecisionExtractionEnvelopeStatus;
+  /**
+   * 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 PlanningDecisionExtractionEnvelopeSelfConfidence$inboundSchema:
+  z.ZodType<
+    PlanningDecisionExtractionEnvelopeSelfConfidence,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(PlanningDecisionExtractionEnvelopeSelfConfidence);
+
+/** @internal */
+export const PlanningDecisionExtractionEnvelopeStatus$inboundSchema: z.ZodType<
+  PlanningDecisionExtractionEnvelopeStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningDecisionExtractionEnvelopeStatus);
+
+/** @internal */
+export const PlanningDecisionExtractionEnvelope$inboundSchema: z.ZodType<
+  PlanningDecisionExtractionEnvelope,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: PlanningDecisionExtraction$inboundSchema,
+  extractedAt: z.nullable(z.string()),
+  modelConfidence: z.nullable(z.number()),
+  schemaVersion: z.number().int(),
+  selfConfidence:
+    PlanningDecisionExtractionEnvelopeSelfConfidence$inboundSchema,
+  snapshotDate: z.string(),
+  status: PlanningDecisionExtractionEnvelopeStatus$inboundSchema,
+  uncertainty: z.nullable(z.string()),
+  verifiedAt: z.nullable(z.string()),
+});
+
+export function planningDecisionExtractionEnvelopeFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningDecisionExtractionEnvelope, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningDecisionExtractionEnvelope$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningDecisionExtractionEnvelope' from JSON`,
+  );
+}