@vepler/sdk 2.24.2 → 2.28.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vepler/sdk",
-  "version": "2.24.2",
+  "version": "2.28.0",
   "author": "Vepler Limited",
   "type": "module",
   "tshy": {

package/src/funcs/avmGetValuationAnalysis.ts

@@ -0,0 +1,163 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.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 { 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 detailed valuation analysis
+ *
+ * @remarks
+ * Get comprehensive valuation analysis for a property including comparable properties, market statistics, confidence metrics, and historical valuations. This endpoint provides detailed insights for property valuation decision-making.
+ */
+export function avmGetValuationAnalysis(
+  client: SDKCore,
+  request: shared.AVMAnalysisRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetValuationAnalysisResponse,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: shared.AVMAnalysisRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetValuationAnalysisResponse,
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => shared.AVMAnalysisRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/avm/analysis")();
+
+  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: "getValuationAnalysis",
+    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,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    operations.GetValuationAnalysisResponse,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetValuationAnalysisResponse$inboundSchema),
+    M.json(400, operations.GetValuationAnalysisResponse$inboundSchema),
+    M.json(404, operations.GetValuationAnalysisResponse$inboundSchema),
+    M.json(422, operations.GetValuationAnalysisResponse$inboundSchema),
+    M.json(500, operations.GetValuationAnalysisResponse$inboundSchema),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/propertyAggregateProperties.ts

@@ -0,0 +1,164 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.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 { 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";
+
+/**
+ * Aggregate property statistics within a geographic area
+ *
+ * @remarks
+ * Execute real-time aggregations (counts, averages, distributions) over property data within a specified geographic boundary. Limited to areas ≤500 km² for reliable performance. Returns computed statistics without individual property documents.
+ */
+export function propertyAggregateProperties(
+  client: SDKCore,
+  request?: shared.PropertyAggregateRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.AggregatePropertiesResponse,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request?: shared.PropertyAggregateRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.AggregatePropertiesResponse,
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      shared.PropertyAggregateRequest$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/property/aggregate")();
+
+  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: "aggregateProperties",
+    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,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    operations.AggregatePropertiesResponse,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.AggregatePropertiesResponse$inboundSchema),
+    M.json(400, operations.AggregatePropertiesResponse$inboundSchema),
+    M.json(500, operations.AggregatePropertiesResponse$inboundSchema),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/hooks/registration.ts

@@ -1,4 +1,4 @@
-import { Hooks } from "./types.js";
+import type { Hooks } from "./types.js";
 
 /*
  * This file is only ever generated once on the first generation and then is free to be modified.
@@ -6,8 +6,7 @@ import { Hooks } from "./types.js";
  * in this file or in separate files in the hooks folder.
  */
 
-// @ts-expect-error remove this line when you add your first hook and hooks is used
-export function initHooks(hooks: Hooks) {
+export function initHooks(_hooks: Hooks) {
   // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook
   // with an instance of a hook that implements that specific Hook interface
   // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance

package/src/lib/config.ts

@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "2.24.2",
+  openapiDocVersion: "2.28.0",
   sdkVersion: "0.8.0",
-  genVersion: "2.795.8",
-  userAgent: "speakeasy-sdk/typescript 0.8.0 2.795.8 2.24.2 @vepler/sdk",
+  genVersion: "2.799.0",
+  userAgent: "speakeasy-sdk/typescript 0.8.0 2.799.0 2.28.0 @vepler/sdk",
 } as const;

package/src/sdk/avm.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { avmGetValuationAnalysis } from "../funcs/avmGetValuationAnalysis.js";
 import { avmPredictPropertyValue } from "../funcs/avmPredictPropertyValue.js";
 import { avmPredictPropertyValueByLocation } from "../funcs/avmPredictPropertyValueByLocation.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -10,6 +11,23 @@ import * as shared from "./models/shared/index.js";
 import { unwrapAsync } from "./types/fp.js";
 
 export class Avm extends ClientSDK {
+  /**
+   * Get detailed valuation analysis
+   *
+   * @remarks
+   * Get comprehensive valuation analysis for a property including comparable properties, market statistics, confidence metrics, and historical valuations. This endpoint provides detailed insights for property valuation decision-making.
+   */
+  async getValuationAnalysis(
+    request: shared.AVMAnalysisRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetValuationAnalysisResponse> {
+    return unwrapAsync(avmGetValuationAnalysis(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Predict property value
    *

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

@@ -0,0 +1,237 @@
+/*
+ * 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";
+
+/**
+ * Error type category
+ */
+export const AggregatePropertiesPropertyType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type AggregatePropertiesPropertyType = ClosedEnum<
+  typeof AggregatePropertiesPropertyType
+>;
+
+export type AggregatePropertiesPropertyError = {
+  /**
+   * 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;
+  /**
+   * Error type category
+   */
+  type: AggregatePropertiesPropertyType;
+};
+
+/**
+ * Error response
+ */
+export type AggregatePropertiesPropertyResponseBody = {
+  error: AggregatePropertiesPropertyError;
+};
+
+/**
+ * Error type category
+ */
+export const AggregatePropertiesType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type AggregatePropertiesType = ClosedEnum<
+  typeof AggregatePropertiesType
+>;
+
+export type AggregatePropertiesError = {
+  /**
+   * 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;
+  /**
+   * Error type category
+   */
+  type: AggregatePropertiesType;
+};
+
+/**
+ * Error response
+ */
+export type AggregatePropertiesResponseBody = {
+  error: AggregatePropertiesError;
+};
+
+export type AggregatePropertiesResponse =
+  | shared.PropertyAggregateResponse
+  | AggregatePropertiesResponseBody
+  | AggregatePropertiesPropertyResponseBody;
+
+/** @internal */
+export const AggregatePropertiesPropertyType$inboundSchema: z.ZodNativeEnum<
+  typeof AggregatePropertiesPropertyType
+> = z.nativeEnum(AggregatePropertiesPropertyType);
+
+/** @internal */
+export const AggregatePropertiesPropertyError$inboundSchema: z.ZodType<
+  AggregatePropertiesPropertyError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: AggregatePropertiesPropertyType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function aggregatePropertiesPropertyErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<AggregatePropertiesPropertyError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AggregatePropertiesPropertyError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AggregatePropertiesPropertyError' from JSON`,
+  );
+}
+
+/** @internal */
+export const AggregatePropertiesPropertyResponseBody$inboundSchema: z.ZodType<
+  AggregatePropertiesPropertyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => AggregatePropertiesPropertyError$inboundSchema),
+});
+
+export function aggregatePropertiesPropertyResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  AggregatePropertiesPropertyResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AggregatePropertiesPropertyResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'AggregatePropertiesPropertyResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const AggregatePropertiesType$inboundSchema: z.ZodNativeEnum<
+  typeof AggregatePropertiesType
+> = z.nativeEnum(AggregatePropertiesType);
+
+/** @internal */
+export const AggregatePropertiesError$inboundSchema: z.ZodType<
+  AggregatePropertiesError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: AggregatePropertiesType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function aggregatePropertiesErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<AggregatePropertiesError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AggregatePropertiesError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AggregatePropertiesError' from JSON`,
+  );
+}
+
+/** @internal */
+export const AggregatePropertiesResponseBody$inboundSchema: z.ZodType<
+  AggregatePropertiesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => AggregatePropertiesError$inboundSchema),
+});
+
+export function aggregatePropertiesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<AggregatePropertiesResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AggregatePropertiesResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AggregatePropertiesResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const AggregatePropertiesResponse$inboundSchema: z.ZodType<
+  AggregatePropertiesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  shared.PropertyAggregateResponse$inboundSchema,
+  z.lazy(() => AggregatePropertiesResponseBody$inboundSchema),
+  z.lazy(() => AggregatePropertiesPropertyResponseBody$inboundSchema),
+]);
+
+export function aggregatePropertiesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AggregatePropertiesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AggregatePropertiesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AggregatePropertiesResponse' from JSON`,
+  );
+}