@vepler/sdk 0.1.0

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

@@ -0,0 +1,214 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PricingData,
+  PricingData$inboundSchema,
+  PricingData$Outbound,
+  PricingData$outboundSchema,
+} from "./pricingdata.js";
+import {
+  PropertyAddress,
+  PropertyAddress$inboundSchema,
+  PropertyAddress$Outbound,
+  PropertyAddress$outboundSchema,
+} from "./propertyaddress.js";
+
+export type Coordinates = {
+  latitude: number;
+  longitude: number;
+};
+
+export type PropertyDataSpatial = {
+  boundary?: any | null | undefined;
+  coordinates: Coordinates;
+};
+
+export type PropertyData = {
+  address: PropertyAddress;
+  classificationCode?: string | undefined;
+  locationId: string;
+  pricing?: PricingData | undefined;
+  propertyId: string;
+  spatial: PropertyDataSpatial;
+};
+
+/** @internal */
+export const Coordinates$inboundSchema: z.ZodType<
+  Coordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  latitude: z.number(),
+  longitude: z.number(),
+});
+
+/** @internal */
+export type Coordinates$Outbound = {
+  latitude: number;
+  longitude: number;
+};
+
+/** @internal */
+export const Coordinates$outboundSchema: z.ZodType<
+  Coordinates$Outbound,
+  z.ZodTypeDef,
+  Coordinates
+> = z.object({
+  latitude: z.number(),
+  longitude: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Coordinates$ {
+  /** @deprecated use `Coordinates$inboundSchema` instead. */
+  export const inboundSchema = Coordinates$inboundSchema;
+  /** @deprecated use `Coordinates$outboundSchema` instead. */
+  export const outboundSchema = Coordinates$outboundSchema;
+  /** @deprecated use `Coordinates$Outbound` instead. */
+  export type Outbound = Coordinates$Outbound;
+}
+
+export function coordinatesToJSON(coordinates: Coordinates): string {
+  return JSON.stringify(Coordinates$outboundSchema.parse(coordinates));
+}
+
+export function coordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<Coordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Coordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Coordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const PropertyDataSpatial$inboundSchema: z.ZodType<
+  PropertyDataSpatial,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  boundary: z.nullable(z.any()).optional(),
+  coordinates: z.lazy(() => Coordinates$inboundSchema),
+});
+
+/** @internal */
+export type PropertyDataSpatial$Outbound = {
+  boundary?: any | null | undefined;
+  coordinates: Coordinates$Outbound;
+};
+
+/** @internal */
+export const PropertyDataSpatial$outboundSchema: z.ZodType<
+  PropertyDataSpatial$Outbound,
+  z.ZodTypeDef,
+  PropertyDataSpatial
+> = z.object({
+  boundary: z.nullable(z.any()).optional(),
+  coordinates: z.lazy(() => Coordinates$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyDataSpatial$ {
+  /** @deprecated use `PropertyDataSpatial$inboundSchema` instead. */
+  export const inboundSchema = PropertyDataSpatial$inboundSchema;
+  /** @deprecated use `PropertyDataSpatial$outboundSchema` instead. */
+  export const outboundSchema = PropertyDataSpatial$outboundSchema;
+  /** @deprecated use `PropertyDataSpatial$Outbound` instead. */
+  export type Outbound = PropertyDataSpatial$Outbound;
+}
+
+export function propertyDataSpatialToJSON(
+  propertyDataSpatial: PropertyDataSpatial,
+): string {
+  return JSON.stringify(
+    PropertyDataSpatial$outboundSchema.parse(propertyDataSpatial),
+  );
+}
+
+export function propertyDataSpatialFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyDataSpatial, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyDataSpatial$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyDataSpatial' from JSON`,
+  );
+}
+
+/** @internal */
+export const PropertyData$inboundSchema: z.ZodType<
+  PropertyData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: PropertyAddress$inboundSchema,
+  classificationCode: z.string().optional(),
+  locationId: z.string(),
+  pricing: PricingData$inboundSchema.optional(),
+  propertyId: z.string(),
+  spatial: z.lazy(() => PropertyDataSpatial$inboundSchema),
+});
+
+/** @internal */
+export type PropertyData$Outbound = {
+  address: PropertyAddress$Outbound;
+  classificationCode?: string | undefined;
+  locationId: string;
+  pricing?: PricingData$Outbound | undefined;
+  propertyId: string;
+  spatial: PropertyDataSpatial$Outbound;
+};
+
+/** @internal */
+export const PropertyData$outboundSchema: z.ZodType<
+  PropertyData$Outbound,
+  z.ZodTypeDef,
+  PropertyData
+> = z.object({
+  address: PropertyAddress$outboundSchema,
+  classificationCode: z.string().optional(),
+  locationId: z.string(),
+  pricing: PricingData$outboundSchema.optional(),
+  propertyId: z.string(),
+  spatial: z.lazy(() => PropertyDataSpatial$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyData$ {
+  /** @deprecated use `PropertyData$inboundSchema` instead. */
+  export const inboundSchema = PropertyData$inboundSchema;
+  /** @deprecated use `PropertyData$outboundSchema` instead. */
+  export const outboundSchema = PropertyData$outboundSchema;
+  /** @deprecated use `PropertyData$Outbound` instead. */
+  export type Outbound = PropertyData$Outbound;
+}
+
+export function propertyDataToJSON(propertyData: PropertyData): string {
+  return JSON.stringify(PropertyData$outboundSchema.parse(propertyData));
+}
+
+export function propertyDataFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyData' from JSON`,
+  );
+}

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

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PropertyFilters = {
+  baths?: Array<number> | undefined;
+  beds?: Array<number> | undefined;
+  epcRating?: Array<string> | undefined;
+  priceMax?: number | undefined;
+  priceMin?: number | undefined;
+  propertyType?: Array<string> | undefined;
+  tenure?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PropertyFilters$inboundSchema: z.ZodType<
+  PropertyFilters,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  baths: z.array(z.number()).optional(),
+  beds: z.array(z.number()).optional(),
+  epcRating: z.array(z.string()).optional(),
+  priceMax: z.number().optional(),
+  priceMin: z.number().optional(),
+  propertyType: z.array(z.string()).optional(),
+  tenure: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type PropertyFilters$Outbound = {
+  baths?: Array<number> | undefined;
+  beds?: Array<number> | undefined;
+  epcRating?: Array<string> | undefined;
+  priceMax?: number | undefined;
+  priceMin?: number | undefined;
+  propertyType?: Array<string> | undefined;
+  tenure?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PropertyFilters$outboundSchema: z.ZodType<
+  PropertyFilters$Outbound,
+  z.ZodTypeDef,
+  PropertyFilters
+> = z.object({
+  baths: z.array(z.number()).optional(),
+  beds: z.array(z.number()).optional(),
+  epcRating: z.array(z.string()).optional(),
+  priceMax: z.number().optional(),
+  priceMin: z.number().optional(),
+  propertyType: z.array(z.string()).optional(),
+  tenure: z.array(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyFilters$ {
+  /** @deprecated use `PropertyFilters$inboundSchema` instead. */
+  export const inboundSchema = PropertyFilters$inboundSchema;
+  /** @deprecated use `PropertyFilters$outboundSchema` instead. */
+  export const outboundSchema = PropertyFilters$outboundSchema;
+  /** @deprecated use `PropertyFilters$Outbound` instead. */
+  export type Outbound = PropertyFilters$Outbound;
+}
+
+export function propertyFiltersToJSON(
+  propertyFilters: PropertyFilters,
+): string {
+  return JSON.stringify(PropertyFilters$outboundSchema.parse(propertyFilters));
+}
+
+export function propertyFiltersFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyFilters, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyFilters$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyFilters' from JSON`,
+  );
+}

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

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PropertyData,
+  PropertyData$inboundSchema,
+  PropertyData$Outbound,
+  PropertyData$outboundSchema,
+} from "./propertydata.js";
+
+export type PropertyListResponse = {
+  result: Array<PropertyData>;
+  size: number;
+  success: boolean;
+  totalSize: number;
+};
+
+/** @internal */
+export const PropertyListResponse$inboundSchema: z.ZodType<
+  PropertyListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  result: z.array(PropertyData$inboundSchema),
+  size: z.number(),
+  success: z.boolean(),
+  totalSize: z.number(),
+});
+
+/** @internal */
+export type PropertyListResponse$Outbound = {
+  result: Array<PropertyData$Outbound>;
+  size: number;
+  success: boolean;
+  totalSize: number;
+};
+
+/** @internal */
+export const PropertyListResponse$outboundSchema: z.ZodType<
+  PropertyListResponse$Outbound,
+  z.ZodTypeDef,
+  PropertyListResponse
+> = z.object({
+  result: z.array(PropertyData$outboundSchema),
+  size: z.number(),
+  success: z.boolean(),
+  totalSize: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyListResponse$ {
+  /** @deprecated use `PropertyListResponse$inboundSchema` instead. */
+  export const inboundSchema = PropertyListResponse$inboundSchema;
+  /** @deprecated use `PropertyListResponse$outboundSchema` instead. */
+  export const outboundSchema = PropertyListResponse$outboundSchema;
+  /** @deprecated use `PropertyListResponse$Outbound` instead. */
+  export type Outbound = PropertyListResponse$Outbound;
+}
+
+export function propertyListResponseToJSON(
+  propertyListResponse: PropertyListResponse,
+): string {
+  return JSON.stringify(
+    PropertyListResponse$outboundSchema.parse(propertyListResponse),
+  );
+}
+
+export function propertyListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyListResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,94 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AreaFilter,
+  AreaFilter$inboundSchema,
+  AreaFilter$Outbound,
+  AreaFilter$outboundSchema,
+} from "./areafilter.js";
+import {
+  PropertyFilters,
+  PropertyFilters$inboundSchema,
+  PropertyFilters$Outbound,
+  PropertyFilters$outboundSchema,
+} from "./propertyfilters.js";
+
+export type PropertyQueryRequest = {
+  area: Array<AreaFilter>;
+  attributes?: string | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  query?: PropertyFilters | undefined;
+};
+
+/** @internal */
+export const PropertyQueryRequest$inboundSchema: z.ZodType<
+  PropertyQueryRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  area: z.array(AreaFilter$inboundSchema),
+  attributes: z.string().optional(),
+  limit: z.number().default(25),
+  offset: z.number().default(0),
+  query: PropertyFilters$inboundSchema.optional(),
+});
+
+/** @internal */
+export type PropertyQueryRequest$Outbound = {
+  area: Array<AreaFilter$Outbound>;
+  attributes?: string | undefined;
+  limit: number;
+  offset: number;
+  query?: PropertyFilters$Outbound | undefined;
+};
+
+/** @internal */
+export const PropertyQueryRequest$outboundSchema: z.ZodType<
+  PropertyQueryRequest$Outbound,
+  z.ZodTypeDef,
+  PropertyQueryRequest
+> = z.object({
+  area: z.array(AreaFilter$outboundSchema),
+  attributes: z.string().optional(),
+  limit: z.number().default(25),
+  offset: z.number().default(0),
+  query: PropertyFilters$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyQueryRequest$ {
+  /** @deprecated use `PropertyQueryRequest$inboundSchema` instead. */
+  export const inboundSchema = PropertyQueryRequest$inboundSchema;
+  /** @deprecated use `PropertyQueryRequest$outboundSchema` instead. */
+  export const outboundSchema = PropertyQueryRequest$outboundSchema;
+  /** @deprecated use `PropertyQueryRequest$Outbound` instead. */
+  export type Outbound = PropertyQueryRequest$Outbound;
+}
+
+export function propertyQueryRequestToJSON(
+  propertyQueryRequest: PropertyQueryRequest,
+): string {
+  return JSON.stringify(
+    PropertyQueryRequest$outboundSchema.parse(propertyQueryRequest),
+  );
+}
+
+export function propertyQueryRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyQueryRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyQueryRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyQueryRequest' from JSON`,
+  );
+}

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

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type Security = {
+  apiKeyAuth: string;
+};
+
+/** @internal */
+export const Security$inboundSchema: z.ZodType<
+  Security,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ApiKeyAuth: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "ApiKeyAuth": "apiKeyAuth",
+  });
+});
+
+/** @internal */
+export type Security$Outbound = {
+  ApiKeyAuth: string;
+};
+
+/** @internal */
+export const Security$outboundSchema: z.ZodType<
+  Security$Outbound,
+  z.ZodTypeDef,
+  Security
+> = z.object({
+  apiKeyAuth: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    apiKeyAuth: "ApiKeyAuth",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Security$ {
+  /** @deprecated use `Security$inboundSchema` instead. */
+  export const inboundSchema = Security$inboundSchema;
+  /** @deprecated use `Security$outboundSchema` instead. */
+  export const outboundSchema = Security$outboundSchema;
+  /** @deprecated use `Security$Outbound` instead. */
+  export type Outbound = Security$Outbound;
+}
+
+export function securityToJSON(security: Security): string {
+  return JSON.stringify(Security$outboundSchema.parse(security));
+}
+
+export function securityFromJSON(
+  jsonString: string,
+): SafeParseResult<Security, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Security$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Security' from JSON`,
+  );
+}

package/src/sdk/planning.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { planningGetV1PlanningApplicationIds } from "../funcs/planningGetV1PlanningApplicationIds.js";
+import { planningGetV1PlanningSourcesSourceIds } from "../funcs/planningGetV1PlanningSourcesSourceIds.js";
+import { planningPostV1PlanningQuery } from "../funcs/planningPostV1PlanningQuery.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Planning extends ClientSDK {
+  /**
+   * Get planning applications by source IDs
+   *
+   * @remarks
+   * Retrieve planning application data using comma-separated source identifiers (e.g., council::reference)
+   */
+  async getV1PlanningSourcesSourceIds(
+    request: operations.GetV1PlanningSourcesSourceIdsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1PlanningSourcesSourceIdsResponse> {
+    return unwrapAsync(planningGetV1PlanningSourcesSourceIds(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get planning applications by application IDs
+   *
+   * @remarks
+   * Retrieve planning application data using comma-separated application identifiers
+   */
+  async getV1PlanningApplicationIds(
+    request: operations.GetV1PlanningApplicationIdsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1PlanningApplicationIdsResponse> {
+    return unwrapAsync(planningGetV1PlanningApplicationIds(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query planning applications with advanced filters
+   *
+   * @remarks
+   * Search for planning applications using councils, status, dates, and other criteria
+   */
+  async postV1PlanningQuery(
+    request?: shared.PlanningQueryRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1PlanningQueryResponse> {
+    return unwrapAsync(planningPostV1PlanningQuery(
+      this,
+      request,
+      options,
+    ));
+  }
+}