@vepler/sdk 2.133.0 → 2.138.0

package/src/sdk/models/errors/querytransactions.ts

@@ -0,0 +1,265 @@
+/*
+ * 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 * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKBaseError } from "./sdkbaseerror.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+/**
+ * Error type category
+ */
+export const QueryTransactionsTransactionsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryTransactionsTransactionsType = OpenEnum<
+  typeof QueryTransactionsTransactionsType
+>;
+
+export type QueryTransactionsTransactionsError = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * URL to relevant documentation
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable error message
+   */
+  message: string;
+  /**
+   * Parameter that caused the error
+   */
+  param?: string | undefined;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Error type category
+   */
+  type: QueryTransactionsTransactionsType;
+};
+
+/**
+ * Error response
+ */
+export type QueryTransactionsTransactionsResponseBodyData = {
+  error: QueryTransactionsTransactionsError;
+};
+
+/**
+ * Error response
+ */
+export class QueryTransactionsTransactionsResponseBody extends SDKBaseError {
+  error: QueryTransactionsTransactionsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryTransactionsTransactionsResponseBodyData;
+
+  constructor(
+    err: QueryTransactionsTransactionsResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "QueryTransactionsTransactionsResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryTransactionsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryTransactionsType = OpenEnum<typeof QueryTransactionsType>;
+
+export type QueryTransactionsError = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * URL to relevant documentation
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable error message
+   */
+  message: string;
+  /**
+   * Parameter that caused the error
+   */
+  param?: string | undefined;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Error type category
+   */
+  type: QueryTransactionsType;
+};
+
+/**
+ * Error response
+ */
+export type QueryTransactionsResponseBodyData = {
+  error: QueryTransactionsError;
+};
+
+/**
+ * Error response
+ */
+export class QueryTransactionsResponseBody extends SDKBaseError {
+  error: QueryTransactionsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryTransactionsResponseBodyData;
+
+  constructor(
+    err: QueryTransactionsResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "QueryTransactionsResponseBody";
+  }
+}
+
+/** @internal */
+export const QueryTransactionsTransactionsType$inboundSchema: z.ZodType<
+  QueryTransactionsTransactionsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryTransactionsTransactionsType);
+
+/** @internal */
+export const QueryTransactionsTransactionsError$inboundSchema: z.ZodType<
+  QueryTransactionsTransactionsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
+  type: QueryTransactionsTransactionsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryTransactionsTransactionsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryTransactionsTransactionsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryTransactionsTransactionsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryTransactionsTransactionsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryTransactionsTransactionsResponseBody$inboundSchema: z.ZodType<
+  QueryTransactionsTransactionsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => QueryTransactionsTransactionsError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new QueryTransactionsTransactionsResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const QueryTransactionsType$inboundSchema: z.ZodType<
+  QueryTransactionsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryTransactionsType);
+
+/** @internal */
+export const QueryTransactionsError$inboundSchema: z.ZodType<
+  QueryTransactionsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
+  type: QueryTransactionsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryTransactionsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryTransactionsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QueryTransactionsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryTransactionsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryTransactionsResponseBody$inboundSchema: z.ZodType<
+  QueryTransactionsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => QueryTransactionsError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new QueryTransactionsResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -9,11 +9,16 @@ export type GetPlanningApplicationsRequest = {
    * One or more planning application UUIDs, separated by commas. Maximum 100 IDs per request. These are the internal system identifiers returned in the 'id' field of application objects (e.g. 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'). If you have a council reference number instead, use the GET /sources/{sourceIds} endpoint.
    */
   applicationIds: string;
+  /**
+   * Comma-separated list of optional expansions to attach to each application. Currently supported: 'extractions' (structured, citation-backed extractions — decision, development, s106, officer assessment, consultee responses). Omitted by default; extractions are large, so request them only when you need the detail.
+   */
+  include?: string | undefined;
 };
 
 /** @internal */
 export type GetPlanningApplicationsRequest$Outbound = {
   applicationIds: string;
+  include?: string | undefined;
 };
 
 /** @internal */
@@ -23,6 +28,7 @@ export const GetPlanningApplicationsRequest$outboundSchema: z.ZodType<
   GetPlanningApplicationsRequest
 > = z.object({
   applicationIds: z.string(),
+  include: z.string().optional(),
 });
 
 export function getPlanningApplicationsRequestToJSON(

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

@@ -5,6 +5,10 @@
 import * as z from "zod/v3";
 
 export type GetPlanningApplicationsBySourceRequest = {
+  /**
+   * Comma-separated list of optional expansions to attach to each application. Currently supported: 'extractions' (structured, citation-backed extractions — decision, development, s106, officer assessment, consultee responses). Omitted by default; extractions are large, so request them only when you need the detail.
+   */
+  include?: string | undefined;
   /**
    * One or more source identifiers, separated by commas. Maximum 100 IDs per request. 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'). The double-colon separator distinguishes the provider from the reference. This is the recommended lookup method when you know the council and reference number.
    */
@@ -13,6 +17,7 @@ export type GetPlanningApplicationsBySourceRequest = {
 
 /** @internal */
 export type GetPlanningApplicationsBySourceRequest$Outbound = {
+  include?: string | undefined;
   sourceIds: string;
 };
 
@@ -22,6 +27,7 @@ export const GetPlanningApplicationsBySourceRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetPlanningApplicationsBySourceRequest
 > = z.object({
+  include: z.string().optional(),
   sourceIds: z.string(),
 });
 

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetTransactionByIdRequest = {
+  /**
+   * Opaque composite transaction id.
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetTransactionByIdRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetTransactionByIdRequest$outboundSchema: z.ZodType<
+  GetTransactionByIdRequest$Outbound,
+  z.ZodTypeDef,
+  GetTransactionByIdRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getTransactionByIdRequestToJSON(
+  getTransactionByIdRequest: GetTransactionByIdRequest,
+): string {
+  return JSON.stringify(
+    GetTransactionByIdRequest$outboundSchema.parse(getTransactionByIdRequest),
+  );
+}

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

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetTransactionsByUprnRequest = {
+  /**
+   * Opaque pagination cursor.
+   */
+  cursor?: string | undefined;
+  /**
+   * Maximum results per page (1–100).
+   */
+  limit?: number | undefined;
+  /**
+   * Unique Property Reference Number.
+   */
+  uprn: string;
+};
+
+/** @internal */
+export type GetTransactionsByUprnRequest$Outbound = {
+  cursor?: string | undefined;
+  limit?: number | undefined;
+  uprn: string;
+};
+
+/** @internal */
+export const GetTransactionsByUprnRequest$outboundSchema: z.ZodType<
+  GetTransactionsByUprnRequest$Outbound,
+  z.ZodTypeDef,
+  GetTransactionsByUprnRequest
+> = z.object({
+  cursor: z.string().optional(),
+  limit: z.number().optional(),
+  uprn: z.string(),
+});
+
+export function getTransactionsByUprnRequestToJSON(
+  getTransactionsByUprnRequest: GetTransactionsByUprnRequest,
+): string {
+  return JSON.stringify(
+    GetTransactionsByUprnRequest$outboundSchema.parse(
+      getTransactionsByUprnRequest,
+    ),
+  );
+}

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

@@ -69,6 +69,8 @@ export * from "./getsitetiles.js";
 export * from "./getsubstationbycode.js";
 export * from "./getsubstationcapacity.js";
 export * from "./getsubstationdfes.js";
+export * from "./gettransactionbyid.js";
+export * from "./gettransactionsbyuprn.js";
 export * from "./getv1titledeedstitlenumber.js";
 export * from "./getv1titledeedstitlenumberdocuments.js";
 export * from "./getv1titledeedstitlenumberdocumentsdocumenttype.js";
@@ -80,6 +82,7 @@ export * from "./lookupuprn.js";
 export * from "./postv1titledeedstitlenumberpurchase.js";
 export * from "./postv1titledeedstitlenumberpurchaseasync.js";
 export * from "./querylistings.js";
+export * from "./querylistingsadvanced.js";
 export * from "./querylistingsbysource.js";
 export * from "./queryschools.js";
 export * from "./queryschoolsbysource.js";

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

@@ -0,0 +1,83 @@
+/*
+ * 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";
+
+/**
+ * Object type identifier
+ */
+export const QueryListingsAdvancedObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type QueryListingsAdvancedObject = ClosedEnum<
+  typeof QueryListingsAdvancedObject
+>;
+
+/**
+ * Paginated response containing aggregated listing documents matching the advanced query, with Stripe-style list envelope metadata.
+ */
+export type QueryListingsAdvancedResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<shared.AdvancedListing>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: QueryListingsAdvancedObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export const QueryListingsAdvancedObject$inboundSchema: z.ZodNativeEnum<
+  typeof QueryListingsAdvancedObject
+> = z.nativeEnum(QueryListingsAdvancedObject);
+
+/** @internal */
+export const QueryListingsAdvancedResponseBody$inboundSchema: z.ZodType<
+  QueryListingsAdvancedResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(shared.AdvancedListing$inboundSchema),
+  has_more: z.boolean(),
+  object: QueryListingsAdvancedObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function queryListingsAdvancedResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryListingsAdvancedResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QueryListingsAdvancedResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryListingsAdvancedResponseBody' from JSON`,
+  );
+}