@vepler/sdk 5.28.1 → 6.1.0

package/src/sdk/models/operations/getgeographyancestors.ts

@@ -0,0 +1,108 @@
+/*
+ * 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 * as shared from "../shared/index.js";
+
+export type GetGeographyAncestorsRequest = {
+  /**
+   * The layer the code belongs to, when it is ambiguous.
+   */
+  areaType?: string | undefined;
+  /**
+   * The GSS code to walk up from.
+   */
+  code: string;
+  /**
+   * Pin a release, e.g. `2025.1`. Omit to follow the current one.
+   */
+  release?: string | undefined;
+  /**
+   * Return only ancestors at this tier, e.g. `ltla`.
+   */
+  tier?: string | undefined;
+};
+
+export const GetGeographyAncestorsObject = {
+  List: "list",
+} as const;
+export type GetGeographyAncestorsObject = ClosedEnum<
+  typeof GetGeographyAncestorsObject
+>;
+
+/**
+ * Containing areas.
+ */
+export type GetGeographyAncestorsResponseBody = {
+  data: Array<shared.GeographyRelatedArea>;
+  object: GetGeographyAncestorsObject;
+  totalCount?: number | undefined;
+  url: string;
+};
+
+/** @internal */
+export type GetGeographyAncestorsRequest$Outbound = {
+  areaType?: string | undefined;
+  code: string;
+  release?: string | undefined;
+  tier?: string | undefined;
+};
+
+/** @internal */
+export const GetGeographyAncestorsRequest$outboundSchema: z.ZodType<
+  GetGeographyAncestorsRequest$Outbound,
+  z.ZodTypeDef,
+  GetGeographyAncestorsRequest
+> = z.object({
+  areaType: z.string().optional(),
+  code: z.string(),
+  release: z.string().optional(),
+  tier: z.string().optional(),
+});
+
+export function getGeographyAncestorsRequestToJSON(
+  getGeographyAncestorsRequest: GetGeographyAncestorsRequest,
+): string {
+  return JSON.stringify(
+    GetGeographyAncestorsRequest$outboundSchema.parse(
+      getGeographyAncestorsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetGeographyAncestorsObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetGeographyAncestorsObject
+> = z.nativeEnum(GetGeographyAncestorsObject);
+
+/** @internal */
+export const GetGeographyAncestorsResponseBody$inboundSchema: z.ZodType<
+  GetGeographyAncestorsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(shared.GeographyRelatedArea$inboundSchema),
+  object: GetGeographyAncestorsObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_count": "totalCount",
+  });
+});
+
+export function getGeographyAncestorsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGeographyAncestorsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetGeographyAncestorsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGeographyAncestorsResponseBody' from JSON`,
+  );
+}

package/src/sdk/models/operations/getgeographyareas.ts

@@ -0,0 +1,100 @@
+/*
+ * 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 * as shared from "../shared/index.js";
+
+export type GetGeographyAreasRequest = {
+  /**
+   * Restrict to one layer, e.g. `lsoa`.
+   */
+  areaType?: string | undefined;
+  /**
+   * Comma-separated GSS codes, up to 100.
+   */
+  codes: string;
+  /**
+   * Restrict to one edition, e.g. `2021`.
+   */
+  vintage?: string | undefined;
+};
+
+export const GetGeographyAreasObject = {
+  List: "list",
+} as const;
+export type GetGeographyAreasObject = ClosedEnum<
+  typeof GetGeographyAreasObject
+>;
+
+/**
+ * The matching areas.
+ */
+export type GetGeographyAreasResponseBody = {
+  data: Array<shared.GeographyArea>;
+  object: GetGeographyAreasObject;
+  totalCount?: number | undefined;
+  url: string;
+};
+
+/** @internal */
+export type GetGeographyAreasRequest$Outbound = {
+  areaType?: string | undefined;
+  codes: string;
+  vintage?: string | undefined;
+};
+
+/** @internal */
+export const GetGeographyAreasRequest$outboundSchema: z.ZodType<
+  GetGeographyAreasRequest$Outbound,
+  z.ZodTypeDef,
+  GetGeographyAreasRequest
+> = z.object({
+  areaType: z.string().optional(),
+  codes: z.string(),
+  vintage: z.string().optional(),
+});
+
+export function getGeographyAreasRequestToJSON(
+  getGeographyAreasRequest: GetGeographyAreasRequest,
+): string {
+  return JSON.stringify(
+    GetGeographyAreasRequest$outboundSchema.parse(getGeographyAreasRequest),
+  );
+}
+
+/** @internal */
+export const GetGeographyAreasObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetGeographyAreasObject
+> = z.nativeEnum(GetGeographyAreasObject);
+
+/** @internal */
+export const GetGeographyAreasResponseBody$inboundSchema: z.ZodType<
+  GetGeographyAreasResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(shared.GeographyArea$inboundSchema),
+  object: GetGeographyAreasObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_count": "totalCount",
+  });
+});
+
+export function getGeographyAreasResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGeographyAreasResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetGeographyAreasResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGeographyAreasResponseBody' from JSON`,
+  );
+}

package/src/sdk/models/operations/getgeographychildren.ts

@@ -0,0 +1,162 @@
+/*
+ * 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 type GetGeographyChildrenRequest = {
+  /**
+   * The layer the parent belongs to, when it is ambiguous.
+   */
+  areaType?: string | undefined;
+  /**
+   * Return only children of this layer.
+   */
+  childType?: string | undefined;
+  /**
+   * The parent GSS code.
+   */
+  code: string;
+  /**
+   * Pin a release, e.g. `2025.1`. Omit to follow the current one.
+   */
+  release?: string | undefined;
+};
+
+export type GetGeographyChildrenData = {
+  /**
+   * The layer as its publisher names it — `lsoa`, `sct_dz`, `nir_dz`. Never carries a vintage.
+   */
+  areaType: string;
+  /**
+   * The GSS code, e.g. `E01000001`.
+   */
+  code: string;
+  fitType: string;
+  /**
+   * Publisher name. Null where none is published — ONS issues no names for Output Areas — and never unique, so never key on it.
+   */
+  name: string | null;
+  /**
+   * `ENG` | `WAL` | `SCO` | `NIR`, or null for a genuinely cross-border area.
+   */
+  nation: string | null;
+  sourceId: string;
+  /**
+   * Cross-nation tier: `small_area` is an LSOA in England and Wales and a Data Zone in Scotland and Northern Ireland.
+   */
+  tier: string | null;
+  /**
+   * The layer edition, e.g. `2021`.
+   */
+  vintage: string | null;
+};
+
+export const GetGeographyChildrenObject = {
+  List: "list",
+} as const;
+export type GetGeographyChildrenObject = ClosedEnum<
+  typeof GetGeographyChildrenObject
+>;
+
+/**
+ * Direct children.
+ */
+export type GetGeographyChildrenResponseBody = {
+  data: Array<GetGeographyChildrenData>;
+  object: GetGeographyChildrenObject;
+  totalCount?: number | undefined;
+  url: string;
+};
+
+/** @internal */
+export type GetGeographyChildrenRequest$Outbound = {
+  areaType?: string | undefined;
+  childType?: string | undefined;
+  code: string;
+  release?: string | undefined;
+};
+
+/** @internal */
+export const GetGeographyChildrenRequest$outboundSchema: z.ZodType<
+  GetGeographyChildrenRequest$Outbound,
+  z.ZodTypeDef,
+  GetGeographyChildrenRequest
+> = z.object({
+  areaType: z.string().optional(),
+  childType: z.string().optional(),
+  code: z.string(),
+  release: z.string().optional(),
+});
+
+export function getGeographyChildrenRequestToJSON(
+  getGeographyChildrenRequest: GetGeographyChildrenRequest,
+): string {
+  return JSON.stringify(
+    GetGeographyChildrenRequest$outboundSchema.parse(
+      getGeographyChildrenRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetGeographyChildrenData$inboundSchema: z.ZodType<
+  GetGeographyChildrenData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaType: z.string(),
+  code: z.string(),
+  fitType: z.string(),
+  name: z.nullable(z.string()),
+  nation: z.nullable(z.string()),
+  sourceId: z.string(),
+  tier: z.nullable(z.string()),
+  vintage: z.nullable(z.string()),
+});
+
+export function getGeographyChildrenDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGeographyChildrenData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetGeographyChildrenData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGeographyChildrenData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetGeographyChildrenObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetGeographyChildrenObject
+> = z.nativeEnum(GetGeographyChildrenObject);
+
+/** @internal */
+export const GetGeographyChildrenResponseBody$inboundSchema: z.ZodType<
+  GetGeographyChildrenResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => GetGeographyChildrenData$inboundSchema)),
+  object: GetGeographyChildrenObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_count": "totalCount",
+  });
+});
+
+export function getGeographyChildrenResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGeographyChildrenResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetGeographyChildrenResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGeographyChildrenResponseBody' from JSON`,
+  );
+}

package/src/sdk/models/operations/getgeographydescendants.ts

@@ -0,0 +1,121 @@
+/*
+ * 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 * as shared from "../shared/index.js";
+
+export type GetGeographyDescendantsRequest = {
+  /**
+   * The layer the code belongs to, when it is ambiguous.
+   */
+  areaType?: string | undefined;
+  /**
+   * The GSS code to walk down from.
+   */
+  code: string;
+  /**
+   * Return only descendants of this layer, e.g. `lsoa`.
+   */
+  descendantType?: string | undefined;
+  /**
+   * Page size, up to 1000.
+   */
+  limit?: number | undefined;
+  /**
+   * Rows to skip.
+   */
+  offset?: number | null | undefined;
+  /**
+   * Pin a release, e.g. `2025.1`. Omit to follow the current one.
+   */
+  release?: string | undefined;
+};
+
+export const GetGeographyDescendantsObject = {
+  List: "list",
+} as const;
+export type GetGeographyDescendantsObject = ClosedEnum<
+  typeof GetGeographyDescendantsObject
+>;
+
+/**
+ * Contained areas.
+ */
+export type GetGeographyDescendantsResponseBody = {
+  data: Array<shared.GeographyRelatedArea>;
+  object: GetGeographyDescendantsObject;
+  totalCount?: number | undefined;
+  url: string;
+};
+
+/** @internal */
+export type GetGeographyDescendantsRequest$Outbound = {
+  areaType?: string | undefined;
+  code: string;
+  descendantType?: string | undefined;
+  limit?: number | undefined;
+  offset?: number | null | undefined;
+  release?: string | undefined;
+};
+
+/** @internal */
+export const GetGeographyDescendantsRequest$outboundSchema: z.ZodType<
+  GetGeographyDescendantsRequest$Outbound,
+  z.ZodTypeDef,
+  GetGeographyDescendantsRequest
+> = z.object({
+  areaType: z.string().optional(),
+  code: z.string(),
+  descendantType: z.string().optional(),
+  limit: z.number().int().optional(),
+  offset: z.nullable(z.number().int()).optional(),
+  release: z.string().optional(),
+});
+
+export function getGeographyDescendantsRequestToJSON(
+  getGeographyDescendantsRequest: GetGeographyDescendantsRequest,
+): string {
+  return JSON.stringify(
+    GetGeographyDescendantsRequest$outboundSchema.parse(
+      getGeographyDescendantsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetGeographyDescendantsObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetGeographyDescendantsObject
+> = z.nativeEnum(GetGeographyDescendantsObject);
+
+/** @internal */
+export const GetGeographyDescendantsResponseBody$inboundSchema: z.ZodType<
+  GetGeographyDescendantsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(shared.GeographyRelatedArea$inboundSchema),
+  object: GetGeographyDescendantsObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_count": "totalCount",
+  });
+});
+
+export function getGeographyDescendantsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGeographyDescendantsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetGeographyDescendantsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGeographyDescendantsResponseBody' from JSON`,
+  );
+}

package/src/sdk/models/operations/getgeographyprovenance.ts

@@ -0,0 +1,135 @@
+/*
+ * 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 type GetGeographyProvenanceRequest = {
+  areaType?: string | undefined;
+  /**
+   * The GSS code.
+   */
+  code: string;
+  vintage?: string | undefined;
+};
+
+export type GetGeographyProvenanceData = {
+  attribution: string | null;
+  custodian: string;
+  fetchedAt: string;
+  fromArchive: boolean;
+  licence: string;
+  sha256: string;
+  sourceId: string;
+  title: string;
+  url: string;
+};
+
+export const GetGeographyProvenanceObject = {
+  List: "list",
+} as const;
+export type GetGeographyProvenanceObject = ClosedEnum<
+  typeof GetGeographyProvenanceObject
+>;
+
+/**
+ * Source records behind this area.
+ */
+export type GetGeographyProvenanceResponseBody = {
+  data: Array<GetGeographyProvenanceData>;
+  object: GetGeographyProvenanceObject;
+  totalCount?: number | undefined;
+  url: string;
+};
+
+/** @internal */
+export type GetGeographyProvenanceRequest$Outbound = {
+  areaType?: string | undefined;
+  code: string;
+  vintage?: string | undefined;
+};
+
+/** @internal */
+export const GetGeographyProvenanceRequest$outboundSchema: z.ZodType<
+  GetGeographyProvenanceRequest$Outbound,
+  z.ZodTypeDef,
+  GetGeographyProvenanceRequest
+> = z.object({
+  areaType: z.string().optional(),
+  code: z.string(),
+  vintage: z.string().optional(),
+});
+
+export function getGeographyProvenanceRequestToJSON(
+  getGeographyProvenanceRequest: GetGeographyProvenanceRequest,
+): string {
+  return JSON.stringify(
+    GetGeographyProvenanceRequest$outboundSchema.parse(
+      getGeographyProvenanceRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetGeographyProvenanceData$inboundSchema: z.ZodType<
+  GetGeographyProvenanceData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  attribution: z.nullable(z.string()),
+  custodian: z.string(),
+  fetchedAt: z.string(),
+  fromArchive: z.boolean(),
+  licence: z.string(),
+  sha256: z.string(),
+  sourceId: z.string(),
+  title: z.string(),
+  url: z.string(),
+});
+
+export function getGeographyProvenanceDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGeographyProvenanceData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetGeographyProvenanceData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGeographyProvenanceData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetGeographyProvenanceObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetGeographyProvenanceObject
+> = z.nativeEnum(GetGeographyProvenanceObject);
+
+/** @internal */
+export const GetGeographyProvenanceResponseBody$inboundSchema: z.ZodType<
+  GetGeographyProvenanceResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => GetGeographyProvenanceData$inboundSchema)),
+  object: GetGeographyProvenanceObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_count": "totalCount",
+  });
+});
+
+export function getGeographyProvenanceResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGeographyProvenanceResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetGeographyProvenanceResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGeographyProvenanceResponseBody' from JSON`,
+  );
+}

package/src/sdk/models/operations/getgeographyrelease.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 GetGeographyReleaseData = {
+  release: string;
+};
+
+/**
+ * The current release.
+ */
+export type GetGeographyReleaseResponseBody = {
+  data: GetGeographyReleaseData;
+};
+
+/** @internal */
+export const GetGeographyReleaseData$inboundSchema: z.ZodType<
+  GetGeographyReleaseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  release: z.string(),
+});
+
+export function getGeographyReleaseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGeographyReleaseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetGeographyReleaseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGeographyReleaseData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetGeographyReleaseResponseBody$inboundSchema: z.ZodType<
+  GetGeographyReleaseResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.lazy(() => GetGeographyReleaseData$inboundSchema),
+});
+
+export function getGeographyReleaseResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetGeographyReleaseResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetGeographyReleaseResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetGeographyReleaseResponseBody' from JSON`,
+  );
+}

package/src/sdk/models/operations/getlistingbyid.ts

@@ -564,9 +564,9 @@ export type GetListingByIdResponseBody = {
    */
   provider: string;
   /**
-   * When the listing was first published by the source, as an ISO 8601 timestamp. It does not change when the listing is later updated.
+   * When the listing was first published by the source, as an ISO 8601 timestamp. It does not change when the listing is later updated, and is null when the source does not publish one.
    */
-  publishedDate: Date;
+  publishedDate?: Date | null | undefined;
   /**
    * Number of reception rooms advertised, meaning the living, dining and sitting rooms. Null when the listing does not state one.
    */
@@ -982,9 +982,9 @@ export const GetListingByIdResponseBody$inboundSchema: z.ZodType<
     priceHistory: z.array(z.lazy(() => PriceHistory$inboundSchema)).optional(),
     propertyType: z.string(),
     provider: z.string(),
-    publishedDate: z.string().datetime({ offset: true }).transform(v =>
-      new Date(v)
-    ),
+    publishedDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
     receptions: z.nullable(z.number()).optional(),
     removedDate: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),