@vepler/sdk 2.18.12 → 2.20.2

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

@@ -0,0 +1,112 @@
+/*
+ * 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";
+
+/**
+ * Physical address
+ */
+export type Address = {
+  city?: string | undefined;
+  line1?: string | undefined;
+  line2?: string | undefined;
+  postcode?: string | undefined;
+};
+
+export type OpeningHours = {
+  friday?: string | undefined;
+  monday?: string | undefined;
+  saturday?: string | undefined;
+  sunday?: string | undefined;
+  thursday?: string | undefined;
+  tuesday?: string | undefined;
+  wednesday?: string | undefined;
+};
+
+export type CouncilContactDetails = {
+  /**
+   * Physical address
+   */
+  address?: Address | undefined;
+  /**
+   * Contact email address
+   */
+  email?: string | undefined;
+  emergencyContact?: string | undefined;
+  openingHours?: OpeningHours | undefined;
+  /**
+   * Contact phone number
+   */
+  phone?: string | undefined;
+};
+
+/** @internal */
+export const Address$inboundSchema: z.ZodType<Address, z.ZodTypeDef, unknown> =
+  z.object({
+    city: z.string().optional(),
+    line1: z.string().optional(),
+    line2: z.string().optional(),
+    postcode: z.string().optional(),
+  });
+
+export function addressFromJSON(
+  jsonString: string,
+): SafeParseResult<Address, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Address$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Address' from JSON`,
+  );
+}
+
+/** @internal */
+export const OpeningHours$inboundSchema: z.ZodType<
+  OpeningHours,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  friday: z.string().optional(),
+  monday: z.string().optional(),
+  saturday: z.string().optional(),
+  sunday: z.string().optional(),
+  thursday: z.string().optional(),
+  tuesday: z.string().optional(),
+  wednesday: z.string().optional(),
+});
+
+export function openingHoursFromJSON(
+  jsonString: string,
+): SafeParseResult<OpeningHours, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OpeningHours$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OpeningHours' from JSON`,
+  );
+}
+
+/** @internal */
+export const CouncilContactDetails$inboundSchema: z.ZodType<
+  CouncilContactDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: z.lazy(() => Address$inboundSchema).optional(),
+  email: z.string().optional(),
+  emergencyContact: z.string().optional(),
+  openingHours: z.lazy(() => OpeningHours$inboundSchema).optional(),
+  phone: z.string().optional(),
+});
+
+export function councilContactDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<CouncilContactDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CouncilContactDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CouncilContactDetails' from JSON`,
+  );
+}

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

@@ -0,0 +1,73 @@
+/*
+ * 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";
+
+export const CouncilErrorResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+export type CouncilErrorResponseType = ClosedEnum<
+  typeof CouncilErrorResponseType
+>;
+
+export type ErrorT = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: CouncilErrorResponseType;
+};
+
+export type CouncilErrorResponse = {
+  error: ErrorT;
+};
+
+/** @internal */
+export const CouncilErrorResponseType$inboundSchema: z.ZodNativeEnum<
+  typeof CouncilErrorResponseType
+> = z.nativeEnum(CouncilErrorResponseType);
+
+/** @internal */
+export const ErrorT$inboundSchema: z.ZodType<ErrorT, z.ZodTypeDef, unknown> = z
+  .object({
+    code: z.string().optional(),
+    message: z.string(),
+    param: z.string().optional(),
+    type: CouncilErrorResponseType$inboundSchema,
+  });
+
+export function errorFromJSON(
+  jsonString: string,
+): SafeParseResult<ErrorT, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ErrorT$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ErrorT' from JSON`,
+  );
+}
+
+/** @internal */
+export const CouncilErrorResponse$inboundSchema: z.ZodType<
+  CouncilErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ErrorT$inboundSchema),
+});
+
+export function councilErrorResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CouncilErrorResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CouncilErrorResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CouncilErrorResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,80 @@
+/*
+ * 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";
+import { Council, Council$inboundSchema } from "./council.js";
+
+/**
+ * Object type identifier
+ */
+export const CouncilListResponseObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type CouncilListResponseObject = ClosedEnum<
+  typeof CouncilListResponseObject
+>;
+
+export type CouncilListResponse = {
+  /**
+   * Array of council objects
+   */
+  data: Array<Council>;
+  /**
+   * Whether more results are available
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: CouncilListResponseObject;
+  /**
+   * Total number of councils matching the query
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export const CouncilListResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof CouncilListResponseObject
+> = z.nativeEnum(CouncilListResponseObject);
+
+/** @internal */
+export const CouncilListResponse$inboundSchema: z.ZodType<
+  CouncilListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(Council$inboundSchema),
+  has_more: z.boolean(),
+  object: CouncilListResponseObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function councilListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CouncilListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CouncilListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CouncilListResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,64 @@
+/*
+ * 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 CouncilMetadata = {
+  alternativeNames?: Array<string> | undefined;
+  /**
+   * Area in square kilometres
+   */
+  areaSquareKm?: number | undefined;
+  localAuthorityId?: number | undefined;
+  planningAuthorityAlternatives?: Array<string> | undefined;
+  planningAuthorityName?: string | undefined;
+  /**
+   * Estimated population
+   */
+  population?: number | undefined;
+  /**
+   * Geographic region
+   */
+  region?: string | undefined;
+  /**
+   * Tags for categorisation
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Council website URL
+   */
+  website?: string | undefined;
+  wikipediaUrl?: string | undefined;
+};
+
+/** @internal */
+export const CouncilMetadata$inboundSchema: z.ZodType<
+  CouncilMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  alternativeNames: z.array(z.string()).optional(),
+  areaSquareKm: z.number().optional(),
+  localAuthorityId: z.number().optional(),
+  planningAuthorityAlternatives: z.array(z.string()).optional(),
+  planningAuthorityName: z.string().optional(),
+  population: z.number().optional(),
+  region: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  website: z.string().optional(),
+  wikipediaUrl: z.string().optional(),
+});
+
+export function councilMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<CouncilMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CouncilMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CouncilMetadata' from JSON`,
+  );
+}

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

@@ -0,0 +1,57 @@
+/*
+ * 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 CouncilServiceUrls = {
+  benefits?: string | undefined;
+  buildingControl?: string | undefined;
+  councilTax?: string | undefined;
+  environmentalHealth?: string | undefined;
+  housing?: string | undefined;
+  licensing?: string | undefined;
+  parking?: string | undefined;
+  planningDocuments?: string | undefined;
+  /**
+   * URL to planning applications portal
+   */
+  planningPortal?: string | undefined;
+  /**
+   * URL to planning search page
+   */
+  planningSearch?: string | undefined;
+  waste?: string | undefined;
+};
+
+/** @internal */
+export const CouncilServiceUrls$inboundSchema: z.ZodType<
+  CouncilServiceUrls,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  benefits: z.string().optional(),
+  buildingControl: z.string().optional(),
+  councilTax: z.string().optional(),
+  environmentalHealth: z.string().optional(),
+  housing: z.string().optional(),
+  licensing: z.string().optional(),
+  parking: z.string().optional(),
+  planningDocuments: z.string().optional(),
+  planningPortal: z.string().optional(),
+  planningSearch: z.string().optional(),
+  waste: z.string().optional(),
+});
+
+export function councilServiceUrlsFromJSON(
+  jsonString: string,
+): SafeParseResult<CouncilServiceUrls, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CouncilServiceUrls$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CouncilServiceUrls' from JSON`,
+  );
+}

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

@@ -11,6 +11,13 @@ export * from "./avmpricerating.js";
 export * from "./builddata.js";
 export * from "./chargeentry.js";
 export * from "./chargehistory.js";
+export * from "./council.js";
+export * from "./councilbranding.js";
+export * from "./councilcontactdetails.js";
+export * from "./councilerrorresponse.js";
+export * from "./councillistresponse.js";
+export * from "./councilmetadata.js";
+export * from "./councilserviceurls.js";
 export * from "./counciltaxbanddetails.js";
 export * from "./counciltaxdata.js";
 export * from "./epcdata.js";

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

@@ -76,7 +76,7 @@ export type Seller = {
 /**
  * Listing status
  */
-export const Status = {
+export const ListingStatus = {
   Live: "live",
   Unavailable: "unavailable",
   Removed: "removed",
@@ -88,19 +88,19 @@ export const Status = {
 /**
  * Listing status
  */
-export type Status = ClosedEnum<typeof Status>;
+export type ListingStatus = ClosedEnum<typeof ListingStatus>;
 
 /**
  * Listing type
  */
-export const Type = {
+export const ListingType = {
   Sale: "sale",
   Rent: "rent",
 } as const;
 /**
  * Listing type
  */
-export type Type = ClosedEnum<typeof Type>;
+export type ListingType = ClosedEnum<typeof ListingType>;
 
 export type Listing = {
   /**
@@ -146,11 +146,11 @@ export type Listing = {
   /**
    * Listing status
    */
-  status?: Status | undefined;
+  status?: ListingStatus | undefined;
   /**
    * Listing type
    */
-  type?: Type | undefined;
+  type?: ListingType | undefined;
 };
 
 /** @internal */
@@ -232,13 +232,13 @@ export function sellerFromJSON(
 }
 
 /** @internal */
-export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
-  .nativeEnum(Status);
+export const ListingStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ListingStatus
+> = z.nativeEnum(ListingStatus);
 
 /** @internal */
-export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
-  Type,
-);
+export const ListingType$inboundSchema: z.ZodNativeEnum<typeof ListingType> = z
+  .nativeEnum(ListingType);
 
 /** @internal */
 export const Listing$inboundSchema: z.ZodType<Listing, z.ZodTypeDef, unknown> =
@@ -257,8 +257,8 @@ export const Listing$inboundSchema: z.ZodType<Listing, z.ZodTypeDef, unknown> =
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ).optional(),
     seller: z.lazy(() => Seller$inboundSchema).optional(),
-    status: Status$inboundSchema.optional(),
-    type: Type$inboundSchema.optional(),
+    status: ListingStatus$inboundSchema.optional(),
+    type: ListingType$inboundSchema.optional(),
   });
 
 export function listingFromJSON(

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

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * School address information
  */
-export type Address = {
+export type SchoolAddress = {
   /**
    * County or region
    */
@@ -65,13 +65,13 @@ export type Location = {
 /**
  * Object type identifier
  */
-export const ObjectT = {
+export const SchoolObject = {
   School: "school",
 } as const;
 /**
  * Object type identifier
  */
-export type ObjectT = ClosedEnum<typeof ObjectT>;
+export type SchoolObject = ClosedEnum<typeof SchoolObject>;
 
 /**
  * Current operational status
@@ -109,7 +109,7 @@ export type School = {
   /**
    * School address information
    */
-  address?: Address | undefined;
+  address?: SchoolAddress | undefined;
   /**
    * Admissions policy type
    */
@@ -189,7 +189,7 @@ export type School = {
   /**
    * Object type identifier
    */
-  object: ObjectT;
+  object: SchoolObject;
   /**
    * Educational phase (e.g., Primary, Secondary, All-through)
    */
@@ -249,22 +249,25 @@ export type School = {
 };
 
 /** @internal */
-export const Address$inboundSchema: z.ZodType<Address, z.ZodTypeDef, unknown> =
-  z.object({
-    county: z.string().optional(),
-    locality: z.string().optional(),
-    postcode: z.string().optional(),
-    street: z.string().optional(),
-    town: z.string().optional(),
-  });
+export const SchoolAddress$inboundSchema: z.ZodType<
+  SchoolAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  county: z.string().optional(),
+  locality: z.string().optional(),
+  postcode: z.string().optional(),
+  street: z.string().optional(),
+  town: z.string().optional(),
+});
 
-export function addressFromJSON(
+export function schoolAddressFromJSON(
   jsonString: string,
-): SafeParseResult<Address, SDKValidationError> {
+): SafeParseResult<SchoolAddress, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Address$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Address' from JSON`,
+    (x) => SchoolAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchoolAddress' from JSON`,
   );
 }
 
@@ -294,8 +297,8 @@ export function locationFromJSON(
 }
 
 /** @internal */
-export const ObjectT$inboundSchema: z.ZodNativeEnum<typeof ObjectT> = z
-  .nativeEnum(ObjectT);
+export const SchoolObject$inboundSchema: z.ZodNativeEnum<typeof SchoolObject> =
+  z.nativeEnum(SchoolObject);
 
 /** @internal */
 export const SchoolStatus$inboundSchema: z.ZodNativeEnum<typeof SchoolStatus> =
@@ -308,7 +311,7 @@ export const SchoolType$inboundSchema: z.ZodNativeEnum<typeof SchoolType> = z
 /** @internal */
 export const School$inboundSchema: z.ZodType<School, z.ZodTypeDef, unknown> = z
   .object({
-    address: z.lazy(() => Address$inboundSchema).optional(),
+    address: z.lazy(() => SchoolAddress$inboundSchema).optional(),
     admissionsPolicy: z.string().optional(),
     ageRange: z.string().optional(),
     capacity: z.number().optional(),
@@ -328,7 +331,7 @@ export const School$inboundSchema: z.ZodType<School, z.ZodTypeDef, unknown> = z
     lowerLevelGeographyCode: z.nullable(z.string()),
     name: z.string(),
     numberOfPupils: z.number().optional(),
-    object: ObjectT$inboundSchema,
+    object: SchoolObject$inboundSchema,
     phase: z.string().optional(),
     religiousCharacter: z.string().optional(),
     slug: z.nullable(z.string()),

package/src/sdk/sdk.ts

@@ -7,6 +7,7 @@ import { Address } from "./address.js";
 import { Areas } from "./areas.js";
 import { Avm } from "./avm.js";
 import { Connectivity } from "./connectivity.js";
+import { Councils } from "./councils.js";
 import { Epc } from "./epc.js";
 import { Listings } from "./listings.js";
 import { Metrics } from "./metrics.js";
@@ -55,6 +56,11 @@ export class SDK extends ClientSDK {
     return (this._avm ??= new Avm(this._options));
   }
 
+  private _councils?: Councils;
+  get councils(): Councils {
+    return (this._councils ??= new Councils(this._options));
+  }
+
   private _epc?: Epc;
   get epc(): Epc {
     return (this._epc ??= new Epc(this._options));