@vepler/sdk 2.155.0 → 2.164.0

package/src/funcs/schoolsCatchmentGetAdmissionArea.ts

@@ -0,0 +1,201 @@
+/*
+ * 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";
+
+/**
+ * Per-school unified admission area
+ *
+ * @remarks
+ * Returns a school's admission boundary in whatever form the data supports, as one GeoJSON FeatureCollection: `polygon` features for hard designated catchments, plus a `distance_radius` feature (school centre `Point` + `radiusM`) when last year's furthest-admitted-pupil distance is known. Lets a client draw a polygon or a circle from a single call. Use `academicYear` to pin the radius year and `asOfDate` for historic polygons.
+ */
+export function schoolsCatchmentGetAdmissionArea(
+  client: SDKCore,
+  request: operations.GetSchoolAdmissionAreaRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.AdmissionAreaResponse,
+    | errors.GetSchoolAdmissionAreaResponseBody
+    | errors.GetSchoolAdmissionAreaSchoolsCatchmentResponseBody
+    | errors.GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.GetSchoolAdmissionAreaRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.AdmissionAreaResponse,
+      | errors.GetSchoolAdmissionAreaResponseBody
+      | errors.GetSchoolAdmissionAreaSchoolsCatchmentResponseBody
+      | errors.GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetSchoolAdmissionAreaRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v1/schools/catchment/admission-area/{id}")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "academicYear": payload.academicYear,
+    "asOfDate": payload.asOfDate,
+  });
+
+  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: "getSchoolAdmissionArea",
+    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.AdmissionAreaResponse,
+    | errors.GetSchoolAdmissionAreaResponseBody
+    | errors.GetSchoolAdmissionAreaSchoolsCatchmentResponseBody
+    | errors.GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, shared.AdmissionAreaResponse$inboundSchema),
+    M.jsonErr(400, errors.GetSchoolAdmissionAreaResponseBody$inboundSchema),
+    M.jsonErr(
+      404,
+      errors.GetSchoolAdmissionAreaSchoolsCatchmentResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors
+        .GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBody$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.155.0",
-  sdkVersion: "0.10.0",
-  genVersion: "2.899.1",
-  userAgent: "speakeasy-sdk/typescript 0.10.0 2.899.1 2.155.0 @vepler/sdk",
+  openapiDocVersion: "2.164.0",
+  sdkVersion: "0.11.0",
+  genVersion: "2.912.1",
+  userAgent: "speakeasy-sdk/typescript 0.11.0 2.912.1 2.164.0 @vepler/sdk",
 } as const;

package/src/lib/encodings.ts

@@ -3,7 +3,7 @@
  */
 
 import { bytesToBase64 } from "./base64.js";
-import { isPlainObject } from "./is-plain-object.js";
+import { isPlainObject } from "./primitives.js";
 
 export class EncodingError extends Error {
   constructor(message: string) {

package/src/lib/matchers.ts

@@ -6,7 +6,7 @@ import { ResponseValidationError } from "../sdk/models/errors/responsevalidation
 import { SDKError } from "../sdk/models/errors/sdkerror.js";
 import { ERR, OK, Result } from "../sdk/types/fp.js";
 import { matchResponse, matchStatusCode, StatusCodePredicate } from "./http.js";
-import { isPlainObject } from "./is-plain-object.js";
+import { isPlainObject } from "./primitives.js";
 
 export type Encoding =
   | "jsonl"

package/src/lib/primitives.ts

@@ -148,3 +148,19 @@ export function allRequired<V extends Record<string, unknown>>(
 
   return v as ReturnType<typeof allRequired<V>>;
 }
+
+export function isPlainObject(
+  value: unknown,
+): value is Record<string, unknown> {
+  if (value === null || typeof value !== "object") return false;
+  if (Object.prototype.toString.call(value) !== "[object Object]") return false;
+  const proto = Object.getPrototypeOf(value);
+  if (proto === null || proto === Object.prototype) return true;
+  // cross-realm plain objects (vm contexts, iframes) inherit from a
+  // different realm's Object.prototype, which itself has a null prototype
+  try {
+    return Object.getPrototypeOf(proto) === null;
+  } catch {
+    return false;
+  }
+}

package/src/lib/retries.ts

@@ -194,6 +194,14 @@ async function retryBackoff(
 }
 
 function retryIntervalFromResponse(res: Response): number {
+  const retryAfterMsVal = res.headers.get("retry-after-ms");
+  if (retryAfterMsVal) {
+    const parsedMs = Number(retryAfterMsVal);
+    if (Number.isFinite(parsedMs) && parsedMs >= 0) {
+      return parsedMs;
+    }
+  }
+
   const retryVal = res.headers.get("retry-after") || "";
   if (!retryVal) {
     return 0;

package/src/lib/sdks.ts

@@ -129,27 +129,55 @@ export class ClientSDK {
     if (path) {
       baseURL.pathname = baseURL.pathname.replace(/\/+$/, "") + "/";
       reqURL = new URL(path, baseURL);
+      if (!reqURL.search && baseURL.search) {
+        reqURL.search = baseURL.search;
+      }
     } else {
       reqURL = baseURL;
     }
     reqURL.hash = "";
 
-    let finalQuery = query || "";
-
-    const secQuery: string[] = [];
-    for (const [k, v] of Object.entries(security?.queryParams || {})) {
-      const q = encodeForm(k, v, { charEncoding: "percent" });
-      if (typeof q !== "undefined") {
-        secQuery.push(q);
+    // Appends already-encoded query pairs to a query string, replacing any
+    // existing pairs with the same key so later sources take precedence.
+    const mergeQuery = (current: string, additions: string): string => {
+      if (!additions) {
+        return current;
       }
-    }
-    if (secQuery.length) {
-      finalQuery += `&${secQuery.join("&")}`;
-    }
+      const additionKeys = new Set(
+        additions
+          .split("&")
+          .filter((pair) => pair !== "")
+          .map((pair) => pair.split("=")[0] ?? ""),
+      );
+      const kept = current.split("&").filter((pair) => {
+        return pair !== "" && !additionKeys.has(pair.split("=")[0] ?? "");
+      });
+      return [...kept, additions].join("&");
+    };
+
+    const encodeQueryRecord = (record: Record<string, unknown>): string => {
+      return Object.entries(record)
+        .map(([k, v]) => {
+          if (v == null) {
+            return undefined;
+          }
+          const value = v;
+          return encodeForm(k, value, {
+            explode: Array.isArray(value),
+            charEncoding: "percent",
+          });
+        })
+        .filter((pair): pair is string => typeof pair !== "undefined")
+        .join("&");
+    };
+
+    const finalQuery = [
+      query || "",
+      encodeQueryRecord(security?.queryParams || {}),
+    ].reduce(mergeQuery, reqURL.search.slice(1));
 
     if (finalQuery) {
-      const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery;
-      reqURL.search = `?${q}`;
+      reqURL.search = `?${finalQuery}`;
     }
 
     const headers = new Headers(opHeaders);

package/src/sdk/conservation.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { conservationGet } from "../funcs/conservationGet.js";
+import { conservationQuery } from "../funcs/conservationQuery.js";
+import { conservationSnapshots } from "../funcs/conservationSnapshots.js";
+import { conservationTypes } from "../funcs/conservationTypes.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 Conservation extends ClientSDK {
+  /**
+   * Retrieve one conservation designation
+   *
+   * @remarks
+   * Retrieve a single designation by its stable `designationId`. Add `?attributes=geometry` for the full boundary, and `?snapshotId=` to pin a historical published snapshot for reproducibility.
+   */
+  async get(
+    request: operations.GetConservationDesignationRequest,
+    options?: RequestOptions,
+  ): Promise<shared.ConservationDesignationFeature> {
+    return unwrapAsync(conservationGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query conservation designations near a place
+   *
+   * @remarks
+   * Retrieve conservation designations for one or more geographic areas — point (with radius), postcode, outcode, bounding-box, polygon or multipolygon. Up to 10 areas per request, OR-combined and deduplicated by `designationId`. Radius 0 returns designations whose boundary contains the point. The full MultiPolygon boundary is opt-in via `attributes: ['geometry']`; source lineage and the harmonised value domain require extended permissions on the licence.
+   */
+  async query(
+    request?: shared.DesignationQueryRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<shared.ConservationDesignationListResponse> {
+    return unwrapAsync(conservationQuery(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List conservation data snapshots
+   *
+   * @remarks
+   * List the published snapshots (data lineage / freshness), newest first.
+   */
+  async snapshots(
+    options?: RequestOptions,
+  ): Promise<shared.DesignationSnapshotListResponse> {
+    return unwrapAsync(conservationSnapshots(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * List conservation designation types
+   *
+   * @remarks
+   * The self-describing vocabulary for this product — every designation type in the current snapshot with its label and count. Public: it needs no licence, so prospects can see coverage before buying.
+   */
+  async types(
+    options?: RequestOptions,
+  ): Promise<shared.DesignationTypeListResponse> {
+    return unwrapAsync(conservationTypes(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/heritage.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { heritageGet } from "../funcs/heritageGet.js";
+import { heritageQuery } from "../funcs/heritageQuery.js";
+import { heritageSnapshots } from "../funcs/heritageSnapshots.js";
+import { heritageTypes } from "../funcs/heritageTypes.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 Heritage extends ClientSDK {
+  /**
+   * Retrieve one heritage designation
+   *
+   * @remarks
+   * Retrieve a single designation by its stable `designationId`. Add `?attributes=geometry` for the full boundary, and `?snapshotId=` to pin a historical published snapshot for reproducibility.
+   */
+  async get(
+    request: operations.GetHeritageDesignationRequest,
+    options?: RequestOptions,
+  ): Promise<shared.HeritageDesignationFeature> {
+    return unwrapAsync(heritageGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query heritage designations near a place
+   *
+   * @remarks
+   * Retrieve heritage designations for one or more geographic areas — point (with radius), postcode, outcode, bounding-box, polygon or multipolygon. Up to 10 areas per request, OR-combined and deduplicated by `designationId`. Radius 0 returns designations whose boundary contains the point. The full MultiPolygon boundary is opt-in via `attributes: ['geometry']`; source lineage and the harmonised value domain require extended permissions on the licence.
+   */
+  async query(
+    request?: shared.DesignationQueryRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<shared.HeritageDesignationListResponse> {
+    return unwrapAsync(heritageQuery(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List heritage data snapshots
+   *
+   * @remarks
+   * List the published snapshots (data lineage / freshness), newest first.
+   */
+  async snapshots(
+    options?: RequestOptions,
+  ): Promise<shared.DesignationSnapshotListResponse> {
+    return unwrapAsync(heritageSnapshots(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * List heritage designation types
+   *
+   * @remarks
+   * The self-describing vocabulary for this product — every designation type in the current snapshot with its label and count. Public: it needs no licence, so prospects can see coverage before buying.
+   */
+  async types(
+    options?: RequestOptions,
+  ): Promise<shared.DesignationTypeListResponse> {
+    return unwrapAsync(heritageTypes(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/landconstraint.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { landConstraintGet } from "../funcs/landConstraintGet.js";
+import { landConstraintQuery } from "../funcs/landConstraintQuery.js";
+import { landConstraintSnapshots } from "../funcs/landConstraintSnapshots.js";
+import { landConstraintTypes } from "../funcs/landConstraintTypes.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 LandConstraint extends ClientSDK {
+  /**
+   * Retrieve one land constraint designation
+   *
+   * @remarks
+   * Retrieve a single designation by its stable `designationId`. Add `?attributes=geometry` for the full boundary, and `?snapshotId=` to pin a historical published snapshot for reproducibility.
+   */
+  async get(
+    request: operations.GetLandConstraintDesignationRequest,
+    options?: RequestOptions,
+  ): Promise<shared.LandConstraintDesignationFeature> {
+    return unwrapAsync(landConstraintGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query land constraint designations near a place
+   *
+   * @remarks
+   * Retrieve land constraint designations for one or more geographic areas — point (with radius), postcode, outcode, bounding-box, polygon or multipolygon. Up to 10 areas per request, OR-combined and deduplicated by `designationId`. Radius 0 returns designations whose boundary contains the point. The full MultiPolygon boundary is opt-in via `attributes: ['geometry']`; source lineage and the harmonised value domain require extended permissions on the licence.
+   */
+  async query(
+    request?: shared.DesignationQueryRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<shared.LandConstraintDesignationListResponse> {
+    return unwrapAsync(landConstraintQuery(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List land constraint data snapshots
+   *
+   * @remarks
+   * List the published snapshots (data lineage / freshness), newest first.
+   */
+  async snapshots(
+    options?: RequestOptions,
+  ): Promise<shared.DesignationSnapshotListResponse> {
+    return unwrapAsync(landConstraintSnapshots(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * List land constraint designation types
+   *
+   * @remarks
+   * The self-describing vocabulary for this product — every designation type in the current snapshot with its label and count. Public: it needs no licence, so prospects can see coverage before buying.
+   */
+  async types(
+    options?: RequestOptions,
+  ): Promise<shared.DesignationTypeListResponse> {
+    return unwrapAsync(landConstraintTypes(
+      this,
+      options,
+    ));
+  }
+}