@vepler/sdk 0.1.0

package/src/sdk/property.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { propertyGetV1PropertyLocationIds } from "../funcs/propertyGetV1PropertyLocationIds.js";
+import { propertyGetV1PropertyPropertyIdPropertyIds } from "../funcs/propertyGetV1PropertyPropertyIdPropertyIds.js";
+import { propertyGetV1PropertySourcesSourceIds } from "../funcs/propertyGetV1PropertySourcesSourceIds.js";
+import { propertyPostV1PropertyPropertiesBySlugs } from "../funcs/propertyPostV1PropertyPropertiesBySlugs.js";
+import { propertyPostV1PropertyQuery } from "../funcs/propertyPostV1PropertyQuery.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 Property extends ClientSDK {
+  /**
+   * Get properties by property IDs
+   *
+   * @remarks
+   * Retrieve property data using comma-separated property identifiers
+   */
+  async getV1PropertyPropertyIdPropertyIds(
+    request: operations.GetV1PropertyPropertyIdPropertyIdsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1PropertyPropertyIdPropertyIdsResponse> {
+    return unwrapAsync(propertyGetV1PropertyPropertyIdPropertyIds(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get properties by source IDs
+   *
+   * @remarks
+   * Retrieve property data using comma-separated source identifiers (e.g., provider-a::123)
+   */
+  async getV1PropertySourcesSourceIds(
+    request: operations.GetV1PropertySourcesSourceIdsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1PropertySourcesSourceIdsResponse> {
+    return unwrapAsync(propertyGetV1PropertySourcesSourceIds(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get properties by location IDs
+   *
+   * @remarks
+   * Retrieve property data using comma-separated location identifiers
+   */
+  async getV1PropertyLocationIds(
+    request: operations.GetV1PropertyLocationIdsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1PropertyLocationIdsResponse> {
+    return unwrapAsync(propertyGetV1PropertyLocationIds(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get properties by slugs
+   *
+   * @remarks
+   * Retrieve property data using an array of property slugs
+   */
+  async postV1PropertyPropertiesBySlugs(
+    request?: shared.PropertyBySlugsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1PropertyPropertiesBySlugsResponse> {
+    return unwrapAsync(propertyPostV1PropertyPropertiesBySlugs(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query properties with advanced filters
+   *
+   * @remarks
+   * Search for properties using location, price, and other criteria
+   */
+  async postV1PropertyQuery(
+    request?: shared.PropertyQueryRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.PostV1PropertyQueryResponse> {
+    return unwrapAsync(propertyPostV1PropertyQuery(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { Health } from "./health.js";
+import { Planning } from "./planning.js";
+import { Property } from "./property.js";
+
+export class SDK extends ClientSDK {
+  private _health?: Health;
+  get health(): Health {
+    return (this._health ??= new Health(this._options));
+  }
+
+  private _planning?: Planning;
+  get planning(): Planning {
+    return (this._planning ??= new Planning(this._options));
+  }
+
+  private _property?: Property;
+  get property(): Property {
+    return (this._property ??= new Property(this._options));
+  }
+}

package/src/sdk/types/async.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type APICall =
+  | {
+      status: "complete";
+      request: Request;
+      response: Response;
+    }
+  | {
+      status: "request-error";
+      request: Request;
+      response?: undefined;
+    }
+  | {
+      status: "invalid";
+      request?: undefined;
+      response?: undefined;
+    };
+
+export class APIPromise<T> implements Promise<T> {
+  readonly #promise: Promise<[T, APICall]>;
+  readonly #unwrapped: Promise<T>;
+
+  readonly [Symbol.toStringTag] = "APIPromise";
+
+  constructor(p: [T, APICall] | Promise<[T, APICall]>) {
+    this.#promise = p instanceof Promise ? p : Promise.resolve(p);
+    this.#unwrapped =
+      p instanceof Promise
+        ? this.#promise.then(([value]) => value)
+        : Promise.resolve(p[0]);
+  }
+
+  then<TResult1 = T, TResult2 = never>(
+    onfulfilled?:
+      | ((value: T) => TResult1 | PromiseLike<TResult1>)
+      | null
+      | undefined,
+    onrejected?:
+      | ((reason: any) => TResult2 | PromiseLike<TResult2>)
+      | null
+      | undefined,
+  ): Promise<TResult1 | TResult2> {
+    return this.#promise.then(
+      onfulfilled ? ([value]) => onfulfilled(value) : void 0,
+      onrejected,
+    );
+  }
+
+  catch<TResult = never>(
+    onrejected?:
+      | ((reason: any) => TResult | PromiseLike<TResult>)
+      | null
+      | undefined,
+  ): Promise<T | TResult> {
+    return this.#unwrapped.catch(onrejected);
+  }
+
+  finally(onfinally?: (() => void) | null | undefined): Promise<T> {
+    return this.#unwrapped.finally(onfinally);
+  }
+
+  $inspect(): Promise<[T, APICall]> {
+    return this.#promise;
+  }
+}

package/src/sdk/types/blobs.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
+  z.custom<Blob>(isBlobLike, {
+    message: "expected a Blob, File or Blob-like object",
+    fatal: true,
+  });
+
+export function isBlobLike(val: unknown): val is Blob {
+  if (val instanceof Blob) {
+    return true;
+  }
+
+  if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) {
+    return false;
+  }
+
+  const name = val[Symbol.toStringTag];
+  if (typeof name !== "string") {
+    return false;
+  }
+  if (name !== "Blob" && name !== "File") {
+    return false;
+  }
+
+  return "stream" in val && typeof val.stream === "function";
+}

package/src/sdk/types/constdatetime.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export function constDateTime(
+  val: string,
+): z.ZodType<string, z.ZodTypeDef, unknown> {
+  return z.custom<string>((v) => {
+    return (
+      typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
+    );
+  }, `Value must be equivalent to ${val}`);
+}

package/src/sdk/types/enums.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+declare const __brand: unique symbol;
+export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+
+export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
+  return value as Unrecognized<T>;
+}
+
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
+export type ClosedEnum<T> = T[keyof T];
+export type OpenEnum<T> =
+  | Prettify<T[keyof T]>
+  | Unrecognized<T[keyof T] extends number ? number : string>;

package/src/sdk/types/fp.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * A monad that captures the result of a function call or an error if it was not
+ * successful. Railway programming, enabled by this type, can be a nicer
+ * alternative to traditional exception throwing because it allows functions to
+ * declare all _known_ errors with static types and then check for them
+ * exhaustively in application code. Thrown exception have a type of `unknown`
+ * and break out of regular control flow of programs making them harder to
+ * inspect and more verbose work with due to try-catch blocks.
+ */
+export type Result<T, E = unknown> =
+  | { ok: true; value: T; error?: never }
+  | { ok: false; value?: never; error: E };
+
+export function OK<V>(value: V): Result<V, never> {
+  return { ok: true, value };
+}
+
+export function ERR<E>(error: E): Result<never, E> {
+  return { ok: false, error };
+}
+
+/**
+ * unwrap is a convenience function for extracting a value from a result or
+ * throwing if there was an error.
+ */
+export function unwrap<T>(r: Result<T, unknown>): T {
+  if (!r.ok) {
+    throw r.error;
+  }
+  return r.value;
+}
+
+/**
+ * unwrapAsync is a convenience function for resolving a value from a Promise
+ * of a result or rejecting if an error occurred.
+ */
+export async function unwrapAsync<T>(
+  pr: Promise<Result<T, unknown>>,
+): Promise<T> {
+  const r = await pr;
+  if (!r.ok) {
+    throw r.error;
+  }
+
+  return r.value;
+}

package/src/sdk/types/index.ts

@@ -0,0 +1,11 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export { blobLikeSchema, isBlobLike } from "./blobs.js";
+export { catchUnrecognizedEnum } from "./enums.js";
+export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
+export type { Result } from "./fp.js";
+export type { PageIterator, Paginator } from "./operations.js";
+export { createPageIterator } from "./operations.js";
+export { RFCDate } from "./rfcdate.js";

package/src/sdk/types/operations.ts

@@ -0,0 +1,105 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { Result } from "./fp.js";
+
+export type Paginator<V> = () => Promise<V & { next: Paginator<V> }> | null;
+
+export type PageIterator<V, PageState = unknown> = V & {
+  next: Paginator<V>;
+  [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
+  "~next"?: PageState | undefined;
+};
+
+export function createPageIterator<V>(
+  page: V & { next: Paginator<V> },
+  halt: (v: V) => boolean,
+): {
+  [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
+} {
+  return {
+    [Symbol.asyncIterator]: async function* paginator() {
+      yield page;
+      if (halt(page)) {
+        return;
+      }
+
+      let p: typeof page | null = page;
+      for (p = await p.next(); p != null; p = await p.next()) {
+        yield p;
+        if (halt(p)) {
+          return;
+        }
+      }
+    },
+  };
+}
+
+/**
+ * This utility create a special iterator that yields a single value and
+ * terminates. It is useful in paginated SDK functions that have early return
+ * paths when things go wrong.
+ */
+export function haltIterator<V extends object>(
+  v: V,
+): PageIterator<V, undefined> {
+  return {
+    ...v,
+    next: () => null,
+    [Symbol.asyncIterator]: async function* paginator() {
+      yield v;
+    },
+  };
+}
+
+/**
+ * Converts an async iterator of `Result<V, E>` into an async iterator of `V`.
+ * When error results occur, the underlying error value is thrown.
+ */
+export async function unwrapResultIterator<V, PageState>(
+  iteratorPromise: Promise<PageIterator<Result<V, unknown>, PageState>>,
+): Promise<PageIterator<V, PageState>> {
+  const resultIter = await iteratorPromise;
+
+  if (!resultIter.ok) {
+    throw resultIter.error;
+  }
+
+  return {
+    ...resultIter.value,
+    next: unwrapPaginator(resultIter.next),
+    "~next": resultIter["~next"],
+    [Symbol.asyncIterator]: async function* paginator() {
+      for await (const page of resultIter) {
+        if (!page.ok) {
+          throw page.error;
+        }
+        yield page.value;
+      }
+    },
+  };
+}
+
+function unwrapPaginator<V>(
+  paginator: Paginator<Result<V, unknown>>,
+): Paginator<V> {
+  return () => {
+    const nextResult = paginator();
+    if (nextResult == null) {
+      return null;
+    }
+    return nextResult.then((res) => {
+      if (!res.ok) {
+        throw res.error;
+      }
+      const out = {
+        ...res.value,
+        next: unwrapPaginator(res.next),
+      };
+      return out;
+    });
+  };
+}
+
+export const URL_OVERRIDE = Symbol("URL_OVERRIDE");

package/src/sdk/types/rfcdate.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+const dateRE = /^\d{4}-\d{2}-\d{2}$/;
+
+export class RFCDate {
+  private serialized: string;
+
+  /**
+   * Creates a new RFCDate instance using today's date.
+   */
+  static today(): RFCDate {
+    return new RFCDate(new Date());
+  }
+
+  /**
+   * Creates a new RFCDate instance using the provided input.
+   * If a string is used then in must be in the format YYYY-MM-DD.
+   *
+   * @param date A Date object or a date string in YYYY-MM-DD format
+   * @example
+   * new RFCDate("2022-01-01")
+   * @example
+   * new RFCDate(new Date())
+   */
+  constructor(date: Date | string) {
+    if (typeof date === "string" && !dateRE.test(date)) {
+      throw new RangeError(
+        "RFCDate: date strings must be in the format YYYY-MM-DD: " + date,
+      );
+    }
+
+    const value = new Date(date);
+    if (isNaN(+value)) {
+      throw new RangeError("RFCDate: invalid date provided: " + date);
+    }
+
+    this.serialized = value.toISOString().slice(0, "YYYY-MM-DD".length);
+    if (!dateRE.test(this.serialized)) {
+      throw new TypeError(
+        `RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`,
+      );
+    }
+  }
+
+  toJSON(): string {
+    return this.toString();
+  }
+
+  toString(): string {
+    return this.serialized;
+  }
+}

package/src/sdk/types/streams.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export function isReadableStream<T = Uint8Array>(
+  val: unknown,
+): val is ReadableStream<T> {
+  if (typeof val !== "object" || val === null) {
+    return false;
+  }
+
+  // Check for the presence of methods specific to ReadableStream
+  const stream = val as ReadableStream<Uint8Array>;
+
+  // ReadableStream has methods like getReader, cancel, and tee
+  return (
+    typeof stream.getReader === "function" &&
+    typeof stream.cancel === "function" &&
+    typeof stream.tee === "function"
+  );
+}

package/test-local.ts

@@ -0,0 +1,145 @@
+#!/usr/bin/env bun
+
+/**
+ * Local Testing Script for Vepler SDK
+ *
+ * Usage:
+ *   1. Set your API key: export VEPLER_API_KEY=your-key-here
+ *   2. Run the test: bun run test-local.ts
+ */
+
+import { SDK } from "./src/index";
+
+// Configuration
+const API_KEY = process.env.VEPLER_API_KEY || "";
+const API_URL = process.env.VEPLER_API_URL || "https://api.vepler.com";
+
+if (!API_KEY) {
+  console.error("❌ Error: VEPLER_API_KEY environment variable is required");
+  console.error("Set it with: export VEPLER_API_KEY=your-api-key");
+  process.exit(1);
+}
+
+// Initialize SDK
+const sdk = new SDK({
+  serverURL: API_URL,
+  apiKey: API_KEY,
+});
+
+// Test results
+const results: { test: string; status: "✅" | "❌"; error?: string }[] = [];
+
+async function test(name: string, fn: () => Promise<void>) {
+  console.log(`\nTesting: ${name}...`);
+  try {
+    await fn();
+    results.push({ test: name, status: "✅" });
+    console.log(`✅ ${name} passed`);
+  } catch (error) {
+    results.push({
+      test: name,
+      status: "❌",
+      error: error instanceof Error ? error.message : String(error)
+    });
+    console.log(`❌ ${name} failed:`, error);
+  }
+}
+
+async function runTests() {
+  console.log("🧪 Vepler SDK Local Testing");
+  console.log("============================");
+  console.log(`API URL: ${API_URL}`);
+  console.log(`API Key: ${API_KEY.slice(0, 8)}...`);
+
+  // Test 1: Health Check (public endpoint)
+  await test("Health Check", async () => {
+    const response = await fetch(`${API_URL}/health`);
+    if (!response.ok) {
+      throw new Error(`Health check failed: ${response.status}`);
+    }
+    const data = await response.json();
+    console.log("  Health response:", data);
+  });
+
+  // Test 2: Get Listing by ID
+  await test("Get Listing by ID", async () => {
+    try {
+      const result = await sdk.listings.getListingById({
+        id: "listing_test_123",
+        forceAggregate: false,
+      });
+      console.log("  Listing found:", result);
+    } catch (error: any) {
+      if (error.statusCode === 404) {
+        console.log("  Expected 404 for test listing ID");
+      } else {
+        throw error;
+      }
+    }
+  });
+
+  // Test 3: Query Listings
+  await test("Query Listings", async () => {
+    const result = await sdk.listings.queryListings({
+      limit: 5,
+    });
+    console.log(`  Found ${result.listings?.length || 0} listings`);
+  });
+
+  // Test 4: Get Listing by Source
+  await test("Get Listing by Source", async () => {
+    try {
+      const result = await sdk.listings.getListingBySource({
+        provider: "rightmove",
+        key: "test-key",
+        forceAggregate: false,
+      });
+      console.log("  Listing found:", result);
+    } catch (error: any) {
+      if (error.statusCode === 404) {
+        console.log("  Expected 404 for test source");
+      } else {
+        throw error;
+      }
+    }
+  });
+
+  // Test 5: Authentication Check
+  await test("Authentication Required", async () => {
+    const response = await fetch(`${API_URL}/v1/listings/test`, {
+      headers: {
+        "X-API-Key": API_KEY,
+      },
+    });
+
+    if (response.status === 401) {
+      throw new Error("Authentication failed - check API key");
+    }
+    console.log(`  Authentication working: ${response.status}`);
+  });
+
+  // Print summary
+  console.log("\n📊 Test Summary");
+  console.log("================");
+  results.forEach((r) => {
+    console.log(`${r.status} ${r.test}`);
+    if (r.error) {
+      console.log(`   Error: ${r.error}`);
+    }
+  });
+
+  const passed = results.filter(r => r.status === "✅").length;
+  const failed = results.filter(r => r.status === "❌").length;
+
+  console.log(`\nTotal: ${passed} passed, ${failed} failed`);
+
+  if (failed > 0) {
+    process.exit(1);
+  }
+}
+
+// Run the tests
+runTests().catch((error) => {
+  console.error("Fatal error:", error);
+  process.exit(1);
+});

package/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "compilerOptions": {
+    "incremental": true,
+    "tsBuildInfoFile": ".tsbuildinfo",
+    "target": "ES2020",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "jsx": "react-jsx",
+
+    "module": "Node16",
+    "moduleResolution": "Node16",
+
+    "allowJs": true,
+
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": ".",
+    
+
+    // https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json
+    "strict": true,
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "exactOptionalPropertyTypes": true,
+    "useUnknownInCatchVariables": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "isolatedModules": true,
+    "checkJs": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules"]
+}