@vepler/sdk 2.133.0 → 2.137.0

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

@@ -0,0 +1,129 @@
+/*
+ * 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 {
+  PlanningDevelopmentExtraction,
+  PlanningDevelopmentExtraction$inboundSchema,
+} from "./planningdevelopmentextraction.js";
+
+/**
+ * The extractor's own confidence in this extraction.
+ */
+export const PlanningDevelopmentExtractionEnvelopeSelfConfidence = {
+  High: "high",
+  Medium: "medium",
+  Low: "low",
+} as const;
+/**
+ * The extractor's own confidence in this extraction.
+ */
+export type PlanningDevelopmentExtractionEnvelopeSelfConfidence = OpenEnum<
+  typeof PlanningDevelopmentExtractionEnvelopeSelfConfidence
+>;
+
+/**
+ * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+ */
+export const PlanningDevelopmentExtractionEnvelopeStatus = {
+  Extracted: "extracted",
+  Verified: "verified",
+} as const;
+/**
+ * Verification state: 'verified' = checked by the L2 verifier; 'extracted' = machine-extracted, not yet verified.
+ */
+export type PlanningDevelopmentExtractionEnvelopeStatus = OpenEnum<
+  typeof PlanningDevelopmentExtractionEnvelopeStatus
+>;
+
+/**
+ * What is being built or changed — type, units, storeys, floor area. Null when not available.
+ */
+export type PlanningDevelopmentExtractionEnvelope = {
+  data: PlanningDevelopmentExtraction;
+  /**
+   * 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: PlanningDevelopmentExtractionEnvelopeSelfConfidence;
+  /**
+   * 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: PlanningDevelopmentExtractionEnvelopeStatus;
+  /**
+   * 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 PlanningDevelopmentExtractionEnvelopeSelfConfidence$inboundSchema:
+  z.ZodType<
+    PlanningDevelopmentExtractionEnvelopeSelfConfidence,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    PlanningDevelopmentExtractionEnvelopeSelfConfidence,
+  );
+
+/** @internal */
+export const PlanningDevelopmentExtractionEnvelopeStatus$inboundSchema:
+  z.ZodType<
+    PlanningDevelopmentExtractionEnvelopeStatus,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(PlanningDevelopmentExtractionEnvelopeStatus);
+
+/** @internal */
+export const PlanningDevelopmentExtractionEnvelope$inboundSchema: z.ZodType<
+  PlanningDevelopmentExtractionEnvelope,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: PlanningDevelopmentExtraction$inboundSchema,
+  extractedAt: z.nullable(z.string()),
+  modelConfidence: z.nullable(z.number()),
+  schemaVersion: z.number().int(),
+  selfConfidence:
+    PlanningDevelopmentExtractionEnvelopeSelfConfidence$inboundSchema,
+  snapshotDate: z.string(),
+  status: PlanningDevelopmentExtractionEnvelopeStatus$inboundSchema,
+  uncertainty: z.nullable(z.string()),
+  verifiedAt: z.nullable(z.string()),
+});
+
+export function planningDevelopmentExtractionEnvelopeFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningDevelopmentExtractionEnvelope, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningDevelopmentExtractionEnvelope$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningDevelopmentExtractionEnvelope' from JSON`,
+  );
+}

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

@@ -0,0 +1,62 @@
+/*
+ * 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";
+
+export const SchemasPresent = {
+  Decision: "decision",
+  Development: "development",
+  S106: "s106",
+  OfficerAssessment: "officerAssessment",
+  ConsulteeResponses: "consulteeResponses",
+} as const;
+export type SchemasPresent = OpenEnum<typeof SchemasPresent>;
+
+export type PlanningExtractionCoverage = {
+  /**
+   * How many of the present extractions are machine-extracted but not yet verified.
+   */
+  extractedCount: number;
+  /**
+   * Which extraction schemas are present and exposed for this application.
+   */
+  schemasPresent: Array<SchemasPresent>;
+  /**
+   * How many of the present extractions are verifier-checked.
+   */
+  verifiedCount: number;
+};
+
+/** @internal */
+export const SchemasPresent$inboundSchema: z.ZodType<
+  SchemasPresent,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SchemasPresent);
+
+/** @internal */
+export const PlanningExtractionCoverage$inboundSchema: z.ZodType<
+  PlanningExtractionCoverage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  extractedCount: z.number().int(),
+  schemasPresent: z.array(SchemasPresent$inboundSchema),
+  verifiedCount: z.number().int(),
+});
+
+export function planningExtractionCoverageFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningExtractionCoverage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningExtractionCoverage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningExtractionCoverage' from JSON`,
+  );
+}