@vepler/sdk 2.133.0 → 2.137.0

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

@@ -0,0 +1,39 @@
+/*
+ * 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 TransactionPrice = {
+  /**
+   * Transaction amount in MINOR currency units (e.g. pence for GBP). Divide by 100 for pounds.
+   */
+  amount: number;
+  /**
+   * ISO 4217 currency code.
+   */
+  currency: string;
+};
+
+/** @internal */
+export const TransactionPrice$inboundSchema: z.ZodType<
+  TransactionPrice,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: z.number().int(),
+  currency: z.string(),
+});
+
+export function transactionPriceFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionPrice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionPrice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionPrice' from JSON`,
+  );
+}

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

@@ -0,0 +1,136 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Comparison operator. Range operators (gt/gte/lt/lte) apply to numeric and date fields.
+ */
+export const TransactionQueryConditionComparator = {
+  Eq: "eq",
+  Ne: "ne",
+  Gt: "gt",
+  Gte: "gte",
+  Lt: "lt",
+  Lte: "lte",
+  In: "in",
+  Nin: "nin",
+} as const;
+/**
+ * Comparison operator. Range operators (gt/gte/lt/lte) apply to numeric and date fields.
+ */
+export type TransactionQueryConditionComparator = ClosedEnum<
+  typeof TransactionQueryConditionComparator
+>;
+
+export type TransactionQueryCondition4 = string | number | boolean;
+
+/**
+ * Value to compare against. Use an array with 'in'/'nin'; a single value for all other comparators.
+ */
+export type TransactionQueryConditionValue =
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean>;
+
+export type TransactionQueryCondition = {
+  /**
+   * Comparison operator. Range operators (gt/gte/lt/lte) apply to numeric and date fields.
+   */
+  comparator: TransactionQueryConditionComparator;
+  /**
+   * Field to filter on. Examples: country, kind, tenure, propertyType, price.amount, date, address.outcode.
+   */
+  field: string;
+  /**
+   * Value to compare against. Use an array with 'in'/'nin'; a single value for all other comparators.
+   */
+  value: string | number | boolean | Array<string | number | boolean>;
+};
+
+/** @internal */
+export const TransactionQueryConditionComparator$outboundSchema:
+  z.ZodNativeEnum<typeof TransactionQueryConditionComparator> = z.nativeEnum(
+    TransactionQueryConditionComparator,
+  );
+
+/** @internal */
+export type TransactionQueryCondition4$Outbound = string | number | boolean;
+
+/** @internal */
+export const TransactionQueryCondition4$outboundSchema: z.ZodType<
+  TransactionQueryCondition4$Outbound,
+  z.ZodTypeDef,
+  TransactionQueryCondition4
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+export function transactionQueryCondition4ToJSON(
+  transactionQueryCondition4: TransactionQueryCondition4,
+): string {
+  return JSON.stringify(
+    TransactionQueryCondition4$outboundSchema.parse(transactionQueryCondition4),
+  );
+}
+
+/** @internal */
+export type TransactionQueryConditionValue$Outbound =
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean>;
+
+/** @internal */
+export const TransactionQueryConditionValue$outboundSchema: z.ZodType<
+  TransactionQueryConditionValue$Outbound,
+  z.ZodTypeDef,
+  TransactionQueryConditionValue
+> = z.union([
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.array(z.union([z.string(), z.number(), z.boolean()])),
+]);
+
+export function transactionQueryConditionValueToJSON(
+  transactionQueryConditionValue: TransactionQueryConditionValue,
+): string {
+  return JSON.stringify(
+    TransactionQueryConditionValue$outboundSchema.parse(
+      transactionQueryConditionValue,
+    ),
+  );
+}
+
+/** @internal */
+export type TransactionQueryCondition$Outbound = {
+  comparator: string;
+  field: string;
+  value: string | number | boolean | Array<string | number | boolean>;
+};
+
+/** @internal */
+export const TransactionQueryCondition$outboundSchema: z.ZodType<
+  TransactionQueryCondition$Outbound,
+  z.ZodTypeDef,
+  TransactionQueryCondition
+> = z.object({
+  comparator: TransactionQueryConditionComparator$outboundSchema,
+  field: z.string(),
+  value: z.union([
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(z.union([z.string(), z.number(), z.boolean()])),
+  ]),
+});
+
+export function transactionQueryConditionToJSON(
+  transactionQueryCondition: TransactionQueryCondition,
+): string {
+  return JSON.stringify(
+    TransactionQueryCondition$outboundSchema.parse(transactionQueryCondition),
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  TransactionQueryCondition,
+  TransactionQueryCondition$Outbound,
+  TransactionQueryCondition$outboundSchema,
+} from "./transactionquerycondition.js";
+
+export type TransactionQueryGroup = {
+  /**
+   * Conditions within this group.
+   */
+  conditions: Array<TransactionQueryCondition>;
+};
+
+/** @internal */
+export type TransactionQueryGroup$Outbound = {
+  conditions: Array<TransactionQueryCondition$Outbound>;
+};
+
+/** @internal */
+export const TransactionQueryGroup$outboundSchema: z.ZodType<
+  TransactionQueryGroup$Outbound,
+  z.ZodTypeDef,
+  TransactionQueryGroup
+> = z.object({
+  conditions: z.array(TransactionQueryCondition$outboundSchema),
+});
+
+export function transactionQueryGroupToJSON(
+  transactionQueryGroup: TransactionQueryGroup,
+): string {
+  return JSON.stringify(
+    TransactionQueryGroup$outboundSchema.parse(transactionQueryGroup),
+  );
+}

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

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  TransactionQueryGroup,
+  TransactionQueryGroup$Outbound,
+  TransactionQueryGroup$outboundSchema,
+} from "./transactionquerygroup.js";
+
+/**
+ * How the groups in this block are combined. Conditions within a single group are always AND'd.
+ */
+export const TransactionQueryOperatorOperator = {
+  And: "AND",
+  Or: "OR",
+} as const;
+/**
+ * How the groups in this block are combined. Conditions within a single group are always AND'd.
+ */
+export type TransactionQueryOperatorOperator = ClosedEnum<
+  typeof TransactionQueryOperatorOperator
+>;
+
+export type TransactionQueryOperator = {
+  /**
+   * Condition groups.
+   */
+  groups: Array<TransactionQueryGroup>;
+  /**
+   * How the groups in this block are combined. Conditions within a single group are always AND'd.
+   */
+  operator: TransactionQueryOperatorOperator;
+};
+
+/** @internal */
+export const TransactionQueryOperatorOperator$outboundSchema: z.ZodNativeEnum<
+  typeof TransactionQueryOperatorOperator
+> = z.nativeEnum(TransactionQueryOperatorOperator);
+
+/** @internal */
+export type TransactionQueryOperator$Outbound = {
+  groups: Array<TransactionQueryGroup$Outbound>;
+  operator: string;
+};
+
+/** @internal */
+export const TransactionQueryOperator$outboundSchema: z.ZodType<
+  TransactionQueryOperator$Outbound,
+  z.ZodTypeDef,
+  TransactionQueryOperator
+> = z.object({
+  groups: z.array(TransactionQueryGroup$outboundSchema),
+  operator: TransactionQueryOperatorOperator$outboundSchema,
+});
+
+export function transactionQueryOperatorToJSON(
+  transactionQueryOperator: TransactionQueryOperator,
+): string {
+  return JSON.stringify(
+    TransactionQueryOperator$outboundSchema.parse(transactionQueryOperator),
+  );
+}

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

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  TransactionAreaFilter,
+  TransactionAreaFilter$Outbound,
+  TransactionAreaFilter$outboundSchema,
+} from "./transactionareafilter.js";
+import {
+  TransactionQueryOperator,
+  TransactionQueryOperator$Outbound,
+  TransactionQueryOperator$outboundSchema,
+} from "./transactionqueryoperator.js";
+
+/**
+ * Comma-separated string or array of fields to include (sparse fieldset).
+ */
+export type TransactionQueryRequestAttributes = string | Array<string>;
+
+/**
+ * Field to sort by (whitelisted).
+ */
+export const TransactionQueryRequestField = {
+  Date: "date",
+  PriceAmount: "price.amount",
+} as const;
+/**
+ * Field to sort by (whitelisted).
+ */
+export type TransactionQueryRequestField = ClosedEnum<
+  typeof TransactionQueryRequestField
+>;
+
+/**
+ * Sort direction.
+ */
+export const TransactionQueryRequestOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort direction.
+ */
+export type TransactionQueryRequestOrder = ClosedEnum<
+  typeof TransactionQueryRequestOrder
+>;
+
+export type TransactionQueryRequestSort = {
+  /**
+   * Field to sort by (whitelisted).
+   */
+  field: TransactionQueryRequestField;
+  /**
+   * Sort direction.
+   */
+  order: TransactionQueryRequestOrder;
+};
+
+/**
+ * Advanced property-transaction search. Postgres-backed, with an Elasticsearch-shaped contract.
+ */
+export type TransactionQueryRequest = {
+  /**
+   * Geographic areas, combined with OR.
+   */
+  area?: Array<TransactionAreaFilter> | undefined;
+  /**
+   * Comma-separated string or array of fields to include (sparse fieldset).
+   */
+  attributes?: string | Array<string> | undefined;
+  /**
+   * Opaque pagination cursor from a previous response's `next_cursor`. Use instead of an offset.
+   */
+  cursor?: string | undefined;
+  /**
+   * Maximum results per page (1–100).
+   */
+  limit?: number | undefined;
+  /**
+   * Structured filter. Top-level blocks are combined with AND (each is an additional constraint); within a block, groups combine by the block operator, and conditions within a group are AND'd.
+   */
+  query?: Array<TransactionQueryOperator> | undefined;
+  /**
+   * Sort configuration (max 3 fields). Defaults to date descending.
+   */
+  sort?: Array<TransactionQueryRequestSort> | undefined;
+};
+
+/** @internal */
+export type TransactionQueryRequestAttributes$Outbound = string | Array<string>;
+
+/** @internal */
+export const TransactionQueryRequestAttributes$outboundSchema: z.ZodType<
+  TransactionQueryRequestAttributes$Outbound,
+  z.ZodTypeDef,
+  TransactionQueryRequestAttributes
+> = z.union([z.string(), z.array(z.string())]);
+
+export function transactionQueryRequestAttributesToJSON(
+  transactionQueryRequestAttributes: TransactionQueryRequestAttributes,
+): string {
+  return JSON.stringify(
+    TransactionQueryRequestAttributes$outboundSchema.parse(
+      transactionQueryRequestAttributes,
+    ),
+  );
+}
+
+/** @internal */
+export const TransactionQueryRequestField$outboundSchema: z.ZodNativeEnum<
+  typeof TransactionQueryRequestField
+> = z.nativeEnum(TransactionQueryRequestField);
+
+/** @internal */
+export const TransactionQueryRequestOrder$outboundSchema: z.ZodNativeEnum<
+  typeof TransactionQueryRequestOrder
+> = z.nativeEnum(TransactionQueryRequestOrder);
+
+/** @internal */
+export type TransactionQueryRequestSort$Outbound = {
+  field: string;
+  order: string;
+};
+
+/** @internal */
+export const TransactionQueryRequestSort$outboundSchema: z.ZodType<
+  TransactionQueryRequestSort$Outbound,
+  z.ZodTypeDef,
+  TransactionQueryRequestSort
+> = z.object({
+  field: TransactionQueryRequestField$outboundSchema,
+  order: TransactionQueryRequestOrder$outboundSchema,
+});
+
+export function transactionQueryRequestSortToJSON(
+  transactionQueryRequestSort: TransactionQueryRequestSort,
+): string {
+  return JSON.stringify(
+    TransactionQueryRequestSort$outboundSchema.parse(
+      transactionQueryRequestSort,
+    ),
+  );
+}
+
+/** @internal */
+export type TransactionQueryRequest$Outbound = {
+  area?: Array<TransactionAreaFilter$Outbound> | undefined;
+  attributes?: string | Array<string> | undefined;
+  cursor?: string | undefined;
+  limit: number;
+  query?: Array<TransactionQueryOperator$Outbound> | undefined;
+  sort?: Array<TransactionQueryRequestSort$Outbound> | undefined;
+};
+
+/** @internal */
+export const TransactionQueryRequest$outboundSchema: z.ZodType<
+  TransactionQueryRequest$Outbound,
+  z.ZodTypeDef,
+  TransactionQueryRequest
+> = z.object({
+  area: z.array(TransactionAreaFilter$outboundSchema).optional(),
+  attributes: z.union([z.string(), z.array(z.string())]).optional(),
+  cursor: z.string().optional(),
+  limit: z.number().default(25),
+  query: z.array(TransactionQueryOperator$outboundSchema).optional(),
+  sort: z.array(z.lazy(() => TransactionQueryRequestSort$outboundSchema))
+    .optional(),
+});
+
+export function transactionQueryRequestToJSON(
+  transactionQueryRequest: TransactionQueryRequest,
+): string {
+  return JSON.stringify(
+    TransactionQueryRequest$outboundSchema.parse(transactionQueryRequest),
+  );
+}

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

@@ -0,0 +1,66 @@
+/*
+ * 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 { Transaction, Transaction$inboundSchema } from "./transaction.js";
+
+export const TransactionsListResponseObject = {
+  List: "list",
+} as const;
+export type TransactionsListResponseObject = ClosedEnum<
+  typeof TransactionsListResponseObject
+>;
+
+/**
+ * Cursor-paginated list of transactions (Stripe-style envelope).
+ */
+export type TransactionsListResponse = {
+  data: Array<Transaction>;
+  /**
+   * Whether more results exist beyond this page.
+   */
+  hasMore: boolean;
+  /**
+   * Opaque cursor for the next page; null when there are no more results.
+   */
+  nextCursor: string | null;
+  object: TransactionsListResponseObject;
+};
+
+/** @internal */
+export const TransactionsListResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof TransactionsListResponseObject
+> = z.nativeEnum(TransactionsListResponseObject);
+
+/** @internal */
+export const TransactionsListResponse$inboundSchema: z.ZodType<
+  TransactionsListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(Transaction$inboundSchema),
+  has_more: z.boolean(),
+  next_cursor: z.nullable(z.string()),
+  object: TransactionsListResponseObject$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "next_cursor": "nextCursor",
+  });
+});
+
+export function transactionsListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionsListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionsListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionsListResponse' from JSON`,
+  );
+}

package/src/sdk/planning.ts

@@ -15,7 +15,7 @@ export class Planning extends ClientSDK {
    * Get planning applications by application IDs
    *
    * @remarks
-   * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead.
+   * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Pass ?include=extractions to attach structured, citation-backed extractions to each application.
    */
   async getPlanningApplications(
     request: operations.GetPlanningApplicationsRequest,
@@ -32,7 +32,7 @@ export class Planning extends ClientSDK {
    * Get planning applications by source IDs
    *
    * @remarks
-   * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number.
+   * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Pass ?include=extractions to attach structured, citation-backed extractions to each application.
    */
   async getPlanningApplicationsBySource(
     request: operations.GetPlanningApplicationsBySourceRequest,

package/src/sdk/sdk.ts

@@ -26,6 +26,7 @@ import { Sites } from "./sites.js";
 import { Streets } from "./streets.js";
 import { System } from "./system.js";
 import { TitleDeeds } from "./titledeeds.js";
+import { Transactions } from "./transactions.js";
 
 export class SDK extends ClientSDK {
   private _address?: Address;
@@ -142,4 +143,9 @@ export class SDK extends ClientSDK {
   get titleDeeds(): TitleDeeds {
     return (this._titleDeeds ??= new TitleDeeds(this._options));
   }
+
+  private _transactions?: Transactions;
+  get transactions(): Transactions {
+    return (this._transactions ??= new Transactions(this._options));
+  }
 }

package/src/sdk/transactions.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { transactionsGetTransactionById } from "../funcs/transactionsGetTransactionById.js";
+import { transactionsGetTransactionsByUprn } from "../funcs/transactionsGetTransactionsByUprn.js";
+import { transactionsQueryTransactions } from "../funcs/transactionsQueryTransactions.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 Transactions extends ClientSDK {
+  /**
+   * Get transaction by id
+   *
+   * @remarks
+   * Retrieve a single transaction by its opaque composite id ({country}:{provider}:{externalId}).
+   */
+  async getTransactionById(
+    request: operations.GetTransactionByIdRequest,
+    options?: RequestOptions,
+  ): Promise<shared.Transaction> {
+    return unwrapAsync(transactionsGetTransactionById(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get transactions by UPRN
+   *
+   * @remarks
+   * Retrieve all transactions matched to a UPRN, newest first, cursor-paginated.
+   */
+  async getTransactionsByUprn(
+    request: operations.GetTransactionsByUprnRequest,
+    options?: RequestOptions,
+  ): Promise<shared.TransactionsListResponse> {
+    return unwrapAsync(transactionsGetTransactionsByUprn(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Advanced transaction search
+   *
+   * @remarks
+   * Search standardised property transactions (completed sales and lease grants) with a structured field query, geographic area filters, sorting and sparse fieldsets. Cursor-paginated. All monetary values are in minor currency units (e.g. pence for GBP).
+   */
+  async queryTransactions(
+    request?: shared.TransactionQueryRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<shared.TransactionsListResponse> {
+    return unwrapAsync(transactionsQueryTransactions(
+      this,
+      request,
+      options,
+    ));
+  }
+}