@vepler/sdk 0.1.0

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

@@ -0,0 +1,139 @@
+/*
+ * 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 PlanningQueryFilters = {
+  /**
+   * Filter by appealed date (from)
+   */
+  appealedDateFrom?: string | undefined;
+  /**
+   * Filter by appealed date (to)
+   */
+  appealedDateTo?: string | undefined;
+  /**
+   * Filter by councils/providers
+   */
+  councils?: Array<string> | undefined;
+  /**
+   * Filter by development categories
+   */
+  developmentCategories?: Array<string> | undefined;
+  /**
+   * Filter by application key/reference
+   */
+  key?: string | undefined;
+  /**
+   * Filter by received date (from)
+   */
+  receivedDateFrom?: string | undefined;
+  /**
+   * Filter by received date (to)
+   */
+  receivedDateTo?: string | undefined;
+  /**
+   * Filter by application statuses
+   */
+  statuses?: Array<string> | undefined;
+  /**
+   * Filter by application types
+   */
+  types?: Array<string> | undefined;
+  /**
+   * Filter by validated date (from)
+   */
+  validatedDateFrom?: string | undefined;
+  /**
+   * Filter by validated date (to)
+   */
+  validatedDateTo?: string | undefined;
+};
+
+/** @internal */
+export const PlanningQueryFilters$inboundSchema: z.ZodType<
+  PlanningQueryFilters,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  appealedDateFrom: z.string().optional(),
+  appealedDateTo: z.string().optional(),
+  councils: z.array(z.string()).optional(),
+  developmentCategories: z.array(z.string()).optional(),
+  key: z.string().optional(),
+  receivedDateFrom: z.string().optional(),
+  receivedDateTo: z.string().optional(),
+  statuses: z.array(z.string()).optional(),
+  types: z.array(z.string()).optional(),
+  validatedDateFrom: z.string().optional(),
+  validatedDateTo: z.string().optional(),
+});
+
+/** @internal */
+export type PlanningQueryFilters$Outbound = {
+  appealedDateFrom?: string | undefined;
+  appealedDateTo?: string | undefined;
+  councils?: Array<string> | undefined;
+  developmentCategories?: Array<string> | undefined;
+  key?: string | undefined;
+  receivedDateFrom?: string | undefined;
+  receivedDateTo?: string | undefined;
+  statuses?: Array<string> | undefined;
+  types?: Array<string> | undefined;
+  validatedDateFrom?: string | undefined;
+  validatedDateTo?: string | undefined;
+};
+
+/** @internal */
+export const PlanningQueryFilters$outboundSchema: z.ZodType<
+  PlanningQueryFilters$Outbound,
+  z.ZodTypeDef,
+  PlanningQueryFilters
+> = z.object({
+  appealedDateFrom: z.string().optional(),
+  appealedDateTo: z.string().optional(),
+  councils: z.array(z.string()).optional(),
+  developmentCategories: z.array(z.string()).optional(),
+  key: z.string().optional(),
+  receivedDateFrom: z.string().optional(),
+  receivedDateTo: z.string().optional(),
+  statuses: z.array(z.string()).optional(),
+  types: z.array(z.string()).optional(),
+  validatedDateFrom: z.string().optional(),
+  validatedDateTo: 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 PlanningQueryFilters$ {
+  /** @deprecated use `PlanningQueryFilters$inboundSchema` instead. */
+  export const inboundSchema = PlanningQueryFilters$inboundSchema;
+  /** @deprecated use `PlanningQueryFilters$outboundSchema` instead. */
+  export const outboundSchema = PlanningQueryFilters$outboundSchema;
+  /** @deprecated use `PlanningQueryFilters$Outbound` instead. */
+  export type Outbound = PlanningQueryFilters$Outbound;
+}
+
+export function planningQueryFiltersToJSON(
+  planningQueryFilters: PlanningQueryFilters,
+): string {
+  return JSON.stringify(
+    PlanningQueryFilters$outboundSchema.parse(planningQueryFilters),
+  );
+}
+
+export function planningQueryFiltersFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningQueryFilters, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningQueryFilters$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningQueryFilters' from JSON`,
+  );
+}

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

@@ -0,0 +1,142 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  PlanningQueryFilters,
+  PlanningQueryFilters$inboundSchema,
+  PlanningQueryFilters$Outbound,
+  PlanningQueryFilters$outboundSchema,
+} from "./planningqueryfilters.js";
+
+export const SortBy = {
+  ReceivedDate: "receivedDate",
+  ValidatedDate: "validatedDate",
+  AppealedDate: "appealedDate",
+  CreatedAt: "createdAt",
+  UpdatedAt: "updatedAt",
+} as const;
+export type SortBy = ClosedEnum<typeof SortBy>;
+
+export const SortOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type SortOrder = ClosedEnum<typeof SortOrder>;
+
+export type PlanningQueryRequest = {
+  limit?: number | undefined;
+  offset?: number | undefined;
+  query?: PlanningQueryFilters | undefined;
+  sortBy?: SortBy | undefined;
+  sortOrder?: SortOrder | undefined;
+};
+
+/** @internal */
+export const SortBy$inboundSchema: z.ZodNativeEnum<typeof SortBy> = z
+  .nativeEnum(SortBy);
+
+/** @internal */
+export const SortBy$outboundSchema: z.ZodNativeEnum<typeof SortBy> =
+  SortBy$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SortBy$ {
+  /** @deprecated use `SortBy$inboundSchema` instead. */
+  export const inboundSchema = SortBy$inboundSchema;
+  /** @deprecated use `SortBy$outboundSchema` instead. */
+  export const outboundSchema = SortBy$outboundSchema;
+}
+
+/** @internal */
+export const SortOrder$inboundSchema: z.ZodNativeEnum<typeof SortOrder> = z
+  .nativeEnum(SortOrder);
+
+/** @internal */
+export const SortOrder$outboundSchema: z.ZodNativeEnum<typeof SortOrder> =
+  SortOrder$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SortOrder$ {
+  /** @deprecated use `SortOrder$inboundSchema` instead. */
+  export const inboundSchema = SortOrder$inboundSchema;
+  /** @deprecated use `SortOrder$outboundSchema` instead. */
+  export const outboundSchema = SortOrder$outboundSchema;
+}
+
+/** @internal */
+export const PlanningQueryRequest$inboundSchema: z.ZodType<
+  PlanningQueryRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  limit: z.number().default(50),
+  offset: z.number().default(0),
+  query: PlanningQueryFilters$inboundSchema.optional(),
+  sortBy: SortBy$inboundSchema.default("receivedDate"),
+  sortOrder: SortOrder$inboundSchema.default("desc"),
+});
+
+/** @internal */
+export type PlanningQueryRequest$Outbound = {
+  limit: number;
+  offset: number;
+  query?: PlanningQueryFilters$Outbound | undefined;
+  sortBy: string;
+  sortOrder: string;
+};
+
+/** @internal */
+export const PlanningQueryRequest$outboundSchema: z.ZodType<
+  PlanningQueryRequest$Outbound,
+  z.ZodTypeDef,
+  PlanningQueryRequest
+> = z.object({
+  limit: z.number().default(50),
+  offset: z.number().default(0),
+  query: PlanningQueryFilters$outboundSchema.optional(),
+  sortBy: SortBy$outboundSchema.default("receivedDate"),
+  sortOrder: SortOrder$outboundSchema.default("desc"),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PlanningQueryRequest$ {
+  /** @deprecated use `PlanningQueryRequest$inboundSchema` instead. */
+  export const inboundSchema = PlanningQueryRequest$inboundSchema;
+  /** @deprecated use `PlanningQueryRequest$outboundSchema` instead. */
+  export const outboundSchema = PlanningQueryRequest$outboundSchema;
+  /** @deprecated use `PlanningQueryRequest$Outbound` instead. */
+  export type Outbound = PlanningQueryRequest$Outbound;
+}
+
+export function planningQueryRequestToJSON(
+  planningQueryRequest: PlanningQueryRequest,
+): string {
+  return JSON.stringify(
+    PlanningQueryRequest$outboundSchema.parse(planningQueryRequest),
+  );
+}
+
+export function planningQueryRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningQueryRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningQueryRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningQueryRequest' from JSON`,
+  );
+}

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

@@ -0,0 +1,74 @@
+/*
+ * 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 PricingData = {
+  currency?: string | undefined;
+  currentPrice?: number | undefined;
+  estimatedValue?: number | undefined;
+  pricePerSqFt?: number | undefined;
+};
+
+/** @internal */
+export const PricingData$inboundSchema: z.ZodType<
+  PricingData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string().default("GBP"),
+  currentPrice: z.number().optional(),
+  estimatedValue: z.number().optional(),
+  pricePerSqFt: z.number().optional(),
+});
+
+/** @internal */
+export type PricingData$Outbound = {
+  currency: string;
+  currentPrice?: number | undefined;
+  estimatedValue?: number | undefined;
+  pricePerSqFt?: number | undefined;
+};
+
+/** @internal */
+export const PricingData$outboundSchema: z.ZodType<
+  PricingData$Outbound,
+  z.ZodTypeDef,
+  PricingData
+> = z.object({
+  currency: z.string().default("GBP"),
+  currentPrice: z.number().optional(),
+  estimatedValue: z.number().optional(),
+  pricePerSqFt: z.number().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PricingData$ {
+  /** @deprecated use `PricingData$inboundSchema` instead. */
+  export const inboundSchema = PricingData$inboundSchema;
+  /** @deprecated use `PricingData$outboundSchema` instead. */
+  export const outboundSchema = PricingData$outboundSchema;
+  /** @deprecated use `PricingData$Outbound` instead. */
+  export type Outbound = PricingData$Outbound;
+}
+
+export function pricingDataToJSON(pricingData: PricingData): string {
+  return JSON.stringify(PricingData$outboundSchema.parse(pricingData));
+}
+
+export function pricingDataFromJSON(
+  jsonString: string,
+): SafeParseResult<PricingData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PricingData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PricingData' from JSON`,
+  );
+}

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

@@ -0,0 +1,92 @@
+/*
+ * 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 PropertyAddress = {
+  country?: string | undefined;
+  county?: string | undefined;
+  displayAddress: string;
+  locality?: string | undefined;
+  postcode: string;
+  streetName?: string | undefined;
+  streetNumber?: string | undefined;
+  town?: string | undefined;
+};
+
+/** @internal */
+export const PropertyAddress$inboundSchema: z.ZodType<
+  PropertyAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  country: z.string().optional(),
+  county: z.string().optional(),
+  displayAddress: z.string(),
+  locality: z.string().optional(),
+  postcode: z.string(),
+  streetName: z.string().optional(),
+  streetNumber: z.string().optional(),
+  town: z.string().optional(),
+});
+
+/** @internal */
+export type PropertyAddress$Outbound = {
+  country?: string | undefined;
+  county?: string | undefined;
+  displayAddress: string;
+  locality?: string | undefined;
+  postcode: string;
+  streetName?: string | undefined;
+  streetNumber?: string | undefined;
+  town?: string | undefined;
+};
+
+/** @internal */
+export const PropertyAddress$outboundSchema: z.ZodType<
+  PropertyAddress$Outbound,
+  z.ZodTypeDef,
+  PropertyAddress
+> = z.object({
+  country: z.string().optional(),
+  county: z.string().optional(),
+  displayAddress: z.string(),
+  locality: z.string().optional(),
+  postcode: z.string(),
+  streetName: z.string().optional(),
+  streetNumber: z.string().optional(),
+  town: 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 PropertyAddress$ {
+  /** @deprecated use `PropertyAddress$inboundSchema` instead. */
+  export const inboundSchema = PropertyAddress$inboundSchema;
+  /** @deprecated use `PropertyAddress$outboundSchema` instead. */
+  export const outboundSchema = PropertyAddress$outboundSchema;
+  /** @deprecated use `PropertyAddress$Outbound` instead. */
+  export type Outbound = PropertyAddress$Outbound;
+}
+
+export function propertyAddressToJSON(
+  propertyAddress: PropertyAddress,
+): string {
+  return JSON.stringify(PropertyAddress$outboundSchema.parse(propertyAddress));
+}
+
+export function propertyAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAddress' from JSON`,
+  );
+}

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

@@ -0,0 +1,90 @@
+/*
+ * 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 PropertyBySlugsRequest = {
+  /**
+   * List of attributes to include in response
+   */
+  attributes?: Array<string> | undefined;
+  /**
+   * Maximum number of results
+   */
+  limit?: number | undefined;
+  /**
+   * Array of property slugs
+   */
+  slugs: Array<string>;
+  /**
+   * Enable tracking for billing purposes
+   */
+  track?: boolean | undefined;
+};
+
+/** @internal */
+export const PropertyBySlugsRequest$inboundSchema: z.ZodType<
+  PropertyBySlugsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  attributes: z.array(z.string()).optional(),
+  limit: z.number().default(25),
+  slugs: z.array(z.string()),
+  track: z.boolean().default(false),
+});
+
+/** @internal */
+export type PropertyBySlugsRequest$Outbound = {
+  attributes?: Array<string> | undefined;
+  limit: number;
+  slugs: Array<string>;
+  track: boolean;
+};
+
+/** @internal */
+export const PropertyBySlugsRequest$outboundSchema: z.ZodType<
+  PropertyBySlugsRequest$Outbound,
+  z.ZodTypeDef,
+  PropertyBySlugsRequest
+> = z.object({
+  attributes: z.array(z.string()).optional(),
+  limit: z.number().default(25),
+  slugs: z.array(z.string()),
+  track: z.boolean().default(false),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyBySlugsRequest$ {
+  /** @deprecated use `PropertyBySlugsRequest$inboundSchema` instead. */
+  export const inboundSchema = PropertyBySlugsRequest$inboundSchema;
+  /** @deprecated use `PropertyBySlugsRequest$outboundSchema` instead. */
+  export const outboundSchema = PropertyBySlugsRequest$outboundSchema;
+  /** @deprecated use `PropertyBySlugsRequest$Outbound` instead. */
+  export type Outbound = PropertyBySlugsRequest$Outbound;
+}
+
+export function propertyBySlugsRequestToJSON(
+  propertyBySlugsRequest: PropertyBySlugsRequest,
+): string {
+  return JSON.stringify(
+    PropertyBySlugsRequest$outboundSchema.parse(propertyBySlugsRequest),
+  );
+}
+
+export function propertyBySlugsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyBySlugsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyBySlugsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyBySlugsRequest' from JSON`,
+  );
+}