@vepler/sdk 2.133.0 → 2.138.0

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,
@@ -49,7 +49,7 @@ export class Planning extends ClientSDK {
    * Query planning applications with advanced filters
    *
    * @remarks
-   * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field. Supports up to 100 results per page.
+   * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include: ["extractions"]` to attach structured, citation-backed extractions. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
    */
   async searchPlanningApplications(
     request?: shared.PlanningQueryRequest | undefined,

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,
+    ));
+  }
+}