@vepler/sdk 6.8.0 → 6.42.0

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

@@ -102,6 +102,8 @@ export * from "./changelogentry.js";
 export * from "./changeloglistresponse.js";
 export * from "./chargeentry.js";
 export * from "./chargehistory.js";
+export * from "./chatcompletion.js";
+export * from "./chatcompletionrequest.js";
 export * from "./companiesbylocationresponse.js";
 export * from "./company.js";
 export * from "./companylistresponse.js";
@@ -244,6 +246,9 @@ export * from "./matchedsubstring.js";
 export * from "./metricdefinition.js";
 export * from "./metricscomparerequest.js";
 export * from "./mitigationmeasure.js";
+export * from "./model.js";
+export * from "./modellist.js";
+export * from "./modelresponse.js";
 export * from "./moneystate.js";
 export * from "./monthlycategorystats.js";
 export * from "./monthlycategorystatslistresponse.js";
@@ -322,7 +327,6 @@ export * from "./propertylistresponse.js";
 export * from "./propertylocationidareafilter.js";
 export * from "./propertymonitoringreceipt.js";
 export * from "./propertymultipolygonareafilter.js";
-export * from "./propertyonstreet.js";
 export * from "./propertyoutcodeareafilter.js";
 export * from "./propertypointareafilter.js";
 export * from "./propertypolygonareafilter.js";
@@ -352,6 +356,7 @@ export * from "./regulatorydomain.js";
 export * from "./regulatoryzone.js";
 export * from "./regulatoryzonechargerate.js";
 export * from "./regulatoryzonecharges.js";
+export * from "./responserequest.js";
 export * from "./reversegeocoderesponse.js";
 export * from "./roomdetails.js";
 export * from "./royalmailaddress.js";
@@ -404,9 +409,15 @@ export * from "./sitequeryrequest.js";
 export * from "./sitetags.js";
 export * from "./socialmedialinks.js";
 export * from "./statsaggregationresult.js";
+export * from "./streetdataset.js";
 export * from "./streetdescriptor.js";
-export * from "./streetdetails.js";
+export * from "./streetfield.js";
 export * from "./streetmatch.js";
+export * from "./streetnameconfidence.js";
+export * from "./streetnamekind.js";
+export * from "./streetproperties.js";
+export * from "./streetpropertyoptions.js";
+export * from "./streetprovenance.js";
 export * from "./streetquerybycoordinates.js";
 export * from "./streetquerybyname.js";
 export * from "./streetquerybypostcode.js";
@@ -414,12 +425,14 @@ export * from "./streetquerybyuprn.js";
 export * from "./streetquerybyusrn.js";
 export * from "./streetqueryrequest.js";
 export * from "./streetqueryresponse.js";
-export * from "./streetstatistics.js";
+export * from "./streetrecord.js";
+export * from "./streetsource.js";
 export * from "./tenancydata.js";
 export * from "./tenuredata.js";
 export * from "./termsaggregationresult.js";
 export * from "./termsbucket.js";
 export * from "./tierskipreason.js";
+export * from "./titlealert.js";
 export * from "./titlecovenant.js";
 export * from "./titledeedapplication.js";
 export * from "./titledeedapplicationlistresponse.js";

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

@@ -0,0 +1,130 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const ModelObject = {
+  Model: "model",
+} as const;
+export type ModelObject = ClosedEnum<typeof ModelObject>;
+
+export const OwnedBy = {
+  Vepler: "vepler",
+} as const;
+export type OwnedBy = ClosedEnum<typeof OwnedBy>;
+
+/**
+ * Kind of input the model takes in the user message.
+ */
+export const InputType = {
+  Image: "image",
+} as const;
+/**
+ * Kind of input the model takes in the user message.
+ */
+export type InputType = ClosedEnum<typeof InputType>;
+
+export type Vepler = {
+  /**
+   * What the model reads and returns.
+   */
+  description: string;
+  /**
+   * Kind of input the model takes in the user message.
+   */
+  inputType: InputType;
+  /**
+   * JSON Schema of the result. A `json_schema` response format may carry it unchanged as `schema`.
+   */
+  outputSchema: { [k: string]: any };
+  /**
+   * Name to send as `response_format.json_schema.name`.
+   */
+  outputSchemaName: string;
+  /**
+   * Version currently served, as reported in `system_fingerprint`.
+   */
+  version: string;
+};
+
+export type Model = {
+  /**
+   * Unix time in seconds when the served version was published.
+   */
+  created: number;
+  /**
+   * Id to pass as `model`.
+   */
+  id: string;
+  object: ModelObject;
+  ownedBy: OwnedBy;
+  vepler: Vepler;
+};
+
+/** @internal */
+export const ModelObject$inboundSchema: z.ZodNativeEnum<typeof ModelObject> = z
+  .nativeEnum(ModelObject);
+
+/** @internal */
+export const OwnedBy$inboundSchema: z.ZodNativeEnum<typeof OwnedBy> = z
+  .nativeEnum(OwnedBy);
+
+/** @internal */
+export const InputType$inboundSchema: z.ZodNativeEnum<typeof InputType> = z
+  .nativeEnum(InputType);
+
+/** @internal */
+export const Vepler$inboundSchema: z.ZodType<Vepler, z.ZodTypeDef, unknown> = z
+  .object({
+    description: z.string(),
+    input_type: InputType$inboundSchema,
+    output_schema: z.record(z.any()),
+    output_schema_name: z.string(),
+    version: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "input_type": "inputType",
+      "output_schema": "outputSchema",
+      "output_schema_name": "outputSchemaName",
+    });
+  });
+
+export function veplerFromJSON(
+  jsonString: string,
+): SafeParseResult<Vepler, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Vepler$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Vepler' from JSON`,
+  );
+}
+
+/** @internal */
+export const Model$inboundSchema: z.ZodType<Model, z.ZodTypeDef, unknown> = z
+  .object({
+    created: z.number().int(),
+    id: z.string(),
+    object: ModelObject$inboundSchema,
+    owned_by: OwnedBy$inboundSchema,
+    vepler: z.lazy(() => Vepler$inboundSchema),
+  }).transform((v) => {
+    return remap$(v, {
+      "owned_by": "ownedBy",
+    });
+  });
+
+export function modelFromJSON(
+  jsonString: string,
+): SafeParseResult<Model, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Model$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Model' from JSON`,
+  );
+}

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

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Model, Model$inboundSchema } from "./model.js";
+
+export const ModelListObject = {
+  List: "list",
+} as const;
+export type ModelListObject = ClosedEnum<typeof ModelListObject>;
+
+export type ModelList = {
+  data: Array<Model>;
+  object: ModelListObject;
+};
+
+/** @internal */
+export const ModelListObject$inboundSchema: z.ZodNativeEnum<
+  typeof ModelListObject
+> = z.nativeEnum(ModelListObject);
+
+/** @internal */
+export const ModelList$inboundSchema: z.ZodType<
+  ModelList,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(Model$inboundSchema),
+  object: ModelListObject$inboundSchema,
+});
+
+export function modelListFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelList, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelList$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelList' from JSON`,
+  );
+}

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

@@ -0,0 +1,242 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const ModelResponseObject = {
+  Response: "response",
+} as const;
+export type ModelResponseObject = ClosedEnum<typeof ModelResponseObject>;
+
+export const ModelResponseSchemasType = {
+  OutputText: "output_text",
+} as const;
+export type ModelResponseSchemasType = ClosedEnum<
+  typeof ModelResponseSchemasType
+>;
+
+export type Content = {
+  /**
+   * Always empty.
+   */
+  annotations: Array<any>;
+  /**
+   * The result: one JSON object, as a string, matching the model's output schema.
+   */
+  text: string;
+  type: ModelResponseSchemasType;
+};
+
+export const ModelResponseRole = {
+  Assistant: "assistant",
+} as const;
+export type ModelResponseRole = ClosedEnum<typeof ModelResponseRole>;
+
+export const ModelResponseSchemasStatus = {
+  Completed: "completed",
+} as const;
+export type ModelResponseSchemasStatus = ClosedEnum<
+  typeof ModelResponseSchemasStatus
+>;
+
+export const ModelResponseType = {
+  Message: "message",
+} as const;
+export type ModelResponseType = ClosedEnum<typeof ModelResponseType>;
+
+export type Output = {
+  content: Array<Content>;
+  id: string;
+  role: ModelResponseRole;
+  status: ModelResponseSchemasStatus;
+  type: ModelResponseType;
+};
+
+export const ModelResponseStatus = {
+  Completed: "completed",
+} as const;
+export type ModelResponseStatus = ClosedEnum<typeof ModelResponseStatus>;
+
+export type ModelResponseUsage = {
+  /**
+   * Tokens the model read as input, including the model's fixed instructions.
+   */
+  inputTokens: number;
+  /**
+   * Tokens the model produced.
+   */
+  outputTokens: number;
+  /**
+   * Sum of input and output tokens.
+   */
+  totalTokens: number;
+  /**
+   * Credits charged for this request. Zero when the result is a repeat served without charge.
+   */
+  veplerCredits: number;
+  /**
+   * Inputs charged for by this request. Zero when the result is a repeat served without charge.
+   */
+  veplerUnits: number;
+};
+
+export type ModelResponse = {
+  /**
+   * Unix time in seconds when the result was produced.
+   */
+  createdAt: number;
+  error?: any | null | undefined;
+  /**
+   * Identifier of this response.
+   */
+  id: string;
+  incompleteDetails?: any | null | undefined;
+  /**
+   * Id of the model that ran.
+   */
+  model: string;
+  object: ModelResponseObject;
+  /**
+   * Exactly one message holding one `output_text` part.
+   */
+  output: Array<Output>;
+  status: ModelResponseStatus;
+  usage: ModelResponseUsage;
+};
+
+/** @internal */
+export const ModelResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof ModelResponseObject
+> = z.nativeEnum(ModelResponseObject);
+
+/** @internal */
+export const ModelResponseSchemasType$inboundSchema: z.ZodNativeEnum<
+  typeof ModelResponseSchemasType
+> = z.nativeEnum(ModelResponseSchemasType);
+
+/** @internal */
+export const Content$inboundSchema: z.ZodType<Content, z.ZodTypeDef, unknown> =
+  z.object({
+    annotations: z.array(z.any()),
+    text: z.string(),
+    type: ModelResponseSchemasType$inboundSchema,
+  });
+
+export function contentFromJSON(
+  jsonString: string,
+): SafeParseResult<Content, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Content$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Content' from JSON`,
+  );
+}
+
+/** @internal */
+export const ModelResponseRole$inboundSchema: z.ZodNativeEnum<
+  typeof ModelResponseRole
+> = z.nativeEnum(ModelResponseRole);
+
+/** @internal */
+export const ModelResponseSchemasStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ModelResponseSchemasStatus
+> = z.nativeEnum(ModelResponseSchemasStatus);
+
+/** @internal */
+export const ModelResponseType$inboundSchema: z.ZodNativeEnum<
+  typeof ModelResponseType
+> = z.nativeEnum(ModelResponseType);
+
+/** @internal */
+export const Output$inboundSchema: z.ZodType<Output, z.ZodTypeDef, unknown> = z
+  .object({
+    content: z.array(z.lazy(() => Content$inboundSchema)),
+    id: z.string(),
+    role: ModelResponseRole$inboundSchema,
+    status: ModelResponseSchemasStatus$inboundSchema,
+    type: ModelResponseType$inboundSchema,
+  });
+
+export function outputFromJSON(
+  jsonString: string,
+): SafeParseResult<Output, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Output$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Output' from JSON`,
+  );
+}
+
+/** @internal */
+export const ModelResponseStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ModelResponseStatus
+> = z.nativeEnum(ModelResponseStatus);
+
+/** @internal */
+export const ModelResponseUsage$inboundSchema: z.ZodType<
+  ModelResponseUsage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  input_tokens: z.number().int(),
+  output_tokens: z.number().int(),
+  total_tokens: z.number().int(),
+  vepler_credits: z.number().int(),
+  vepler_units: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "input_tokens": "inputTokens",
+    "output_tokens": "outputTokens",
+    "total_tokens": "totalTokens",
+    "vepler_credits": "veplerCredits",
+    "vepler_units": "veplerUnits",
+  });
+});
+
+export function modelResponseUsageFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelResponseUsage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelResponseUsage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelResponseUsage' from JSON`,
+  );
+}
+
+/** @internal */
+export const ModelResponse$inboundSchema: z.ZodType<
+  ModelResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.number().int(),
+  error: z.nullable(z.any()).optional(),
+  id: z.string(),
+  incomplete_details: z.nullable(z.any()).optional(),
+  model: z.string(),
+  object: ModelResponseObject$inboundSchema,
+  output: z.array(z.lazy(() => Output$inboundSchema)),
+  status: ModelResponseStatus$inboundSchema,
+  usage: z.lazy(() => ModelResponseUsage$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "incomplete_details": "incompleteDetails",
+  });
+});
+
+export function modelResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelResponse' from JSON`,
+  );
+}

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

@@ -16,14 +16,16 @@ import {
 /**
  * How the scheme charges. Under 'daily' a non-compliant vehicle pays a charge for each day it enters, as in the English clean air zones, the London ULEZ and LEZ, and the Oxford ZEZ. Under 'penalty' there is nothing to pay in advance and a non-compliant entry is fined, as in the Scottish low emission zones.
  */
-export const Model = {
+export const RegulatoryZoneChargesModel = {
   Daily: "daily",
   Penalty: "penalty",
 } as const;
 /**
  * How the scheme charges. Under 'daily' a non-compliant vehicle pays a charge for each day it enters, as in the English clean air zones, the London ULEZ and LEZ, and the Oxford ZEZ. Under 'penalty' there is nothing to pay in advance and a non-compliant entry is fined, as in the Scottish low emission zones.
  */
-export type Model = OpenEnum<typeof Model>;
+export type RegulatoryZoneChargesModel = OpenEnum<
+  typeof RegulatoryZoneChargesModel
+>;
 
 /**
  * What it costs to enter the zone in a non-compliant vehicle. Present only for schemes that levy something, such as clean air zones, the ULEZ, low emission zones, zero emission zones and their international equivalents. Absent for designations that carry no charge, such as air quality management areas and flood zones.
@@ -36,7 +38,7 @@ export type RegulatoryZoneCharges = {
   /**
    * How the scheme charges. Under 'daily' a non-compliant vehicle pays a charge for each day it enters, as in the English clean air zones, the London ULEZ and LEZ, and the Oxford ZEZ. Under 'penalty' there is nothing to pay in advance and a non-compliant entry is fined, as in the Scottish low emission zones.
    */
-  model: Model;
+  model: RegulatoryZoneChargesModel;
   /**
    * One line per vehicle class the schedule covers.
    */
@@ -52,8 +54,11 @@ export type RegulatoryZoneCharges = {
 };
 
 /** @internal */
-export const Model$inboundSchema: z.ZodType<Model, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Model);
+export const RegulatoryZoneChargesModel$inboundSchema: z.ZodType<
+  RegulatoryZoneChargesModel,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(RegulatoryZoneChargesModel);
 
 /** @internal */
 export const RegulatoryZoneCharges$inboundSchema: z.ZodType<
@@ -62,7 +67,7 @@ export const RegulatoryZoneCharges$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   asOf: z.nullable(z.string()).optional(),
-  model: Model$inboundSchema,
+  model: RegulatoryZoneChargesModel$inboundSchema,
   rates: z.array(RegulatoryZoneChargeRate$inboundSchema),
   source: z.nullable(z.string()).optional(),
   year: z.number().int(),