@vepler/sdk 2.133.0 → 2.138.0

package/src/funcs/transactionsGetTransactionsByUprn.ts

@@ -0,0 +1,191 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as operations from "../sdk/models/operations/index.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Get transactions by UPRN
+ *
+ * @remarks
+ * Retrieve all transactions matched to a UPRN, newest first, cursor-paginated.
+ */
+export function transactionsGetTransactionsByUprn(
+  client: SDKCore,
+  request: operations.GetTransactionsByUprnRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.TransactionsListResponse,
+    | errors.GetTransactionsByUprnResponseBody
+    | errors.GetTransactionsByUprnTransactionsResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.GetTransactionsByUprnRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.TransactionsListResponse,
+      | errors.GetTransactionsByUprnResponseBody
+      | errors.GetTransactionsByUprnTransactionsResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetTransactionsByUprnRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    uprn: encodeSimple("uprn", payload.uprn, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v1/transactions/by-uprn/{uprn}")(pathParams);
+
+  const query = encodeFormQuery({
+    "cursor": payload.cursor,
+    "limit": payload.limit,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getTransactionsByUprn",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    shared.TransactionsListResponse,
+    | errors.GetTransactionsByUprnResponseBody
+    | errors.GetTransactionsByUprnTransactionsResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, shared.TransactionsListResponse$inboundSchema),
+    M.jsonErr(400, errors.GetTransactionsByUprnResponseBody$inboundSchema),
+    M.jsonErr(
+      500,
+      errors.GetTransactionsByUprnTransactionsResponseBody$inboundSchema,
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/transactionsQueryTransactions.ts

@@ -0,0 +1,181 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * 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).
+ */
+export function transactionsQueryTransactions(
+  client: SDKCore,
+  request?: shared.TransactionQueryRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.TransactionsListResponse,
+    | errors.QueryTransactionsResponseBody
+    | errors.QueryTransactionsTransactionsResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request?: shared.TransactionQueryRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.TransactionsListResponse,
+      | errors.QueryTransactionsResponseBody
+      | errors.QueryTransactionsTransactionsResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      shared.TransactionQueryRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = payload === undefined
+    ? null
+    : encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/transactions/query")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "queryTransactions",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    shared.TransactionsListResponse,
+    | errors.QueryTransactionsResponseBody
+    | errors.QueryTransactionsTransactionsResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, shared.TransactionsListResponse$inboundSchema),
+    M.jsonErr(400, errors.QueryTransactionsResponseBody$inboundSchema),
+    M.jsonErr(
+      500,
+      errors.QueryTransactionsTransactionsResponseBody$inboundSchema,
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "2.133.0",
+  openapiDocVersion: "2.138.0",
   sdkVersion: "0.10.0",
-  genVersion: "2.888.0",
-  userAgent: "speakeasy-sdk/typescript 0.10.0 2.888.0 2.133.0 @vepler/sdk",
+  genVersion: "2.889.1",
+  userAgent: "speakeasy-sdk/typescript 0.10.0 2.889.1 2.138.0 @vepler/sdk",
 } as const;

package/src/sdk/listings.ts

@@ -6,9 +6,11 @@ import { listingsGetListingById } from "../funcs/listingsGetListingById.js";
 import { listingsGetListingBySource } from "../funcs/listingsGetListingBySource.js";
 import { listingsGetListingsByLocation } from "../funcs/listingsGetListingsByLocation.js";
 import { listingsQueryListings } from "../funcs/listingsQueryListings.js";
+import { listingsQueryListingsAdvanced } from "../funcs/listingsQueryListingsAdvanced.js";
 import { listingsQueryListingsBySource } from "../funcs/listingsQueryListingsBySource.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 Listings extends ClientSDK {
@@ -80,6 +82,23 @@ export class Listings extends ClientSDK {
     ));
   }
 
+  /**
+   * Advanced listing search
+   *
+   * @remarks
+   * Search aggregated property listings with a structured field query, geographic area filters, sorting and sparse fieldsets — backed by Elasticsearch. Returns nested aggregated listing documents (distinct from the simpler POST /listings/query).
+   */
+  async queryListingsAdvanced(
+    request?: shared.ListingAdvancedQueryRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.QueryListingsAdvancedResponseBody> {
+    return unwrapAsync(listingsQueryListingsAdvanced(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Query listings by provider and keys
    *

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

@@ -0,0 +1,263 @@
+/*
+ * 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 GetTransactionByIdTransactionsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetTransactionByIdTransactionsType = OpenEnum<
+  typeof GetTransactionByIdTransactionsType
+>;
+
+export type GetTransactionByIdTransactionsError = {
+  /**
+   * 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: GetTransactionByIdTransactionsType;
+};
+
+/**
+ * Error response
+ */
+export type GetTransactionByIdTransactionsResponseBodyData = {
+  error: GetTransactionByIdTransactionsError;
+};
+
+/**
+ * Error response
+ */
+export class GetTransactionByIdTransactionsResponseBody extends SDKBaseError {
+  error: GetTransactionByIdTransactionsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetTransactionByIdTransactionsResponseBodyData;
+
+  constructor(
+    err: GetTransactionByIdTransactionsResponseBodyData,
+    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 = "GetTransactionByIdTransactionsResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetTransactionByIdType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetTransactionByIdType = OpenEnum<typeof GetTransactionByIdType>;
+
+export type GetTransactionByIdError = {
+  /**
+   * 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: GetTransactionByIdType;
+};
+
+/**
+ * Error response
+ */
+export type GetTransactionByIdResponseBodyData = {
+  error: GetTransactionByIdError;
+};
+
+/**
+ * Error response
+ */
+export class GetTransactionByIdResponseBody extends SDKBaseError {
+  error: GetTransactionByIdError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetTransactionByIdResponseBodyData;
+
+  constructor(
+    err: GetTransactionByIdResponseBodyData,
+    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 = "GetTransactionByIdResponseBody";
+  }
+}
+
+/** @internal */
+export const GetTransactionByIdTransactionsType$inboundSchema: z.ZodType<
+  GetTransactionByIdTransactionsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetTransactionByIdTransactionsType);
+
+/** @internal */
+export const GetTransactionByIdTransactionsError$inboundSchema: z.ZodType<
+  GetTransactionByIdTransactionsError,
+  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: GetTransactionByIdTransactionsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getTransactionByIdTransactionsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetTransactionByIdTransactionsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetTransactionByIdTransactionsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetTransactionByIdTransactionsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetTransactionByIdTransactionsResponseBody$inboundSchema:
+  z.ZodType<GetTransactionByIdTransactionsResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      error: z.lazy(() => GetTransactionByIdTransactionsError$inboundSchema),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new GetTransactionByIdTransactionsResponseBody(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });
+
+/** @internal */
+export const GetTransactionByIdType$inboundSchema: z.ZodType<
+  GetTransactionByIdType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetTransactionByIdType);
+
+/** @internal */
+export const GetTransactionByIdError$inboundSchema: z.ZodType<
+  GetTransactionByIdError,
+  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: GetTransactionByIdType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getTransactionByIdErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetTransactionByIdError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetTransactionByIdError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetTransactionByIdError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetTransactionByIdResponseBody$inboundSchema: z.ZodType<
+  GetTransactionByIdResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetTransactionByIdError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetTransactionByIdResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });