@vepler/sdk 2.12.0 → 2.20.2

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

@@ -0,0 +1,191 @@
+/*
+ * 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 {
+  CouncilBranding,
+  CouncilBranding$inboundSchema,
+} from "./councilbranding.js";
+import {
+  CouncilContactDetails,
+  CouncilContactDetails$inboundSchema,
+} from "./councilcontactdetails.js";
+import {
+  CouncilMetadata,
+  CouncilMetadata$inboundSchema,
+} from "./councilmetadata.js";
+import {
+  CouncilServiceUrls,
+  CouncilServiceUrls$inboundSchema,
+} from "./councilserviceurls.js";
+
+/**
+ * Country code (GB = Great Britain, IE = Ireland)
+ */
+export const Country = {
+  Gb: "GB",
+  Ie: "IE",
+} as const;
+/**
+ * Country code (GB = Great Britain, IE = Ireland)
+ */
+export type Country = ClosedEnum<typeof Country>;
+
+/**
+ * Object type identifier
+ */
+export const ObjectT = {
+  Council: "council",
+} as const;
+/**
+ * Object type identifier
+ */
+export type ObjectT = ClosedEnum<typeof ObjectT>;
+
+/**
+ * Current operational status
+ */
+export const Status = {
+  Active: "active",
+  Merged: "merged",
+  Abolished: "abolished",
+  Inactive: "inactive",
+} as const;
+/**
+ * Current operational status
+ */
+export type Status = ClosedEnum<typeof Status>;
+
+/**
+ * Council type classification
+ */
+export const Type = {
+  Unitary: "unitary",
+  Metropolitan: "metropolitan",
+  County: "county",
+  LondonBorough: "london_borough",
+  District: "district",
+  LocalAuthority: "local_authority",
+} as const;
+/**
+ * Council type classification
+ */
+export type Type = ClosedEnum<typeof Type>;
+
+export type Council = {
+  branding?: CouncilBranding | undefined;
+  contactDetails?: CouncilContactDetails | undefined;
+  /**
+   * Irish council code
+   */
+  councilCode?: string | null | undefined;
+  /**
+   * Country code (GB = Great Britain, IE = Ireland)
+   */
+  country: Country;
+  /**
+   * Creation timestamp in ISO format
+   */
+  createdAt: string;
+  /**
+   * Government Statistical Service code
+   */
+  gssCode: string | null;
+  /**
+   * Unique council identifier
+   */
+  id: string;
+  metadata?: CouncilMetadata | undefined;
+  /**
+   * Official council name
+   */
+  name: string;
+  /**
+   * Normalised name for matching
+   */
+  normalisedName: string;
+  /**
+   * Object type identifier
+   */
+  object: ObjectT;
+  /**
+   * Office for National Statistics code
+   */
+  onsCode: string | null;
+  /**
+   * Provider identifier for integrations
+   */
+  providerId: string | null;
+  serviceUrls?: CouncilServiceUrls | undefined;
+  /**
+   * Current operational status
+   */
+  status: Status;
+  /**
+   * Council type classification
+   */
+  type: Type | null;
+  /**
+   * Last update timestamp in ISO format
+   */
+  updatedAt: string;
+  /**
+   * Whether the council data has been verified
+   */
+  verified: boolean;
+};
+
+/** @internal */
+export const Country$inboundSchema: z.ZodNativeEnum<typeof Country> = z
+  .nativeEnum(Country);
+
+/** @internal */
+export const ObjectT$inboundSchema: z.ZodNativeEnum<typeof ObjectT> = z
+  .nativeEnum(ObjectT);
+
+/** @internal */
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
+  .nativeEnum(Status);
+
+/** @internal */
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
+
+/** @internal */
+export const Council$inboundSchema: z.ZodType<Council, z.ZodTypeDef, unknown> =
+  z.object({
+    branding: CouncilBranding$inboundSchema.optional(),
+    contactDetails: CouncilContactDetails$inboundSchema.optional(),
+    councilCode: z.nullable(z.string()).optional(),
+    country: Country$inboundSchema,
+    createdAt: z.string(),
+    gssCode: z.nullable(z.string()),
+    id: z.string(),
+    metadata: CouncilMetadata$inboundSchema.optional(),
+    name: z.string(),
+    normalisedName: z.string(),
+    object: ObjectT$inboundSchema,
+    onsCode: z.nullable(z.string()),
+    providerId: z.nullable(z.string()),
+    serviceUrls: CouncilServiceUrls$inboundSchema.optional(),
+    status: Status$inboundSchema,
+    type: z.nullable(Type$inboundSchema),
+    updatedAt: z.string(),
+    verified: z.boolean(),
+  });
+
+export function councilFromJSON(
+  jsonString: string,
+): SafeParseResult<Council, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Council$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Council' from JSON`,
+  );
+}

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

@@ -0,0 +1,77 @@
+/*
+ * 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 SocialMedia = {
+  facebook?: string | undefined;
+  instagram?: string | undefined;
+  linkedin?: string | undefined;
+  twitter?: string | undefined;
+  youtube?: string | undefined;
+};
+
+export type CouncilBranding = {
+  /**
+   * URL to council logo
+   */
+  logoUrl?: string | undefined;
+  /**
+   * Primary brand colour (hex)
+   */
+  primaryColour?: string | undefined;
+  /**
+   * Secondary brand colour (hex)
+   */
+  secondaryColour?: string | undefined;
+  socialMedia?: SocialMedia | undefined;
+};
+
+/** @internal */
+export const SocialMedia$inboundSchema: z.ZodType<
+  SocialMedia,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  facebook: z.string().optional(),
+  instagram: z.string().optional(),
+  linkedin: z.string().optional(),
+  twitter: z.string().optional(),
+  youtube: z.string().optional(),
+});
+
+export function socialMediaFromJSON(
+  jsonString: string,
+): SafeParseResult<SocialMedia, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SocialMedia$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SocialMedia' from JSON`,
+  );
+}
+
+/** @internal */
+export const CouncilBranding$inboundSchema: z.ZodType<
+  CouncilBranding,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  logoUrl: z.string().optional(),
+  primaryColour: z.string().optional(),
+  secondaryColour: z.string().optional(),
+  socialMedia: z.lazy(() => SocialMedia$inboundSchema).optional(),
+});
+
+export function councilBrandingFromJSON(
+  jsonString: string,
+): SafeParseResult<CouncilBranding, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CouncilBranding$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CouncilBranding' from JSON`,
+  );
+}

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";