@vepler/sdk 2.39.0 → 2.45.0

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

@@ -0,0 +1,284 @@
+/*
+ * 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";
+
+export type SearchECRRequest = {
+  /**
+   * Filter by connection lifecycle status (e.g. connected, accepted, contracted, in_scoping)
+   */
+  connectionStatus?: string | undefined;
+  /**
+   * Filter by country (ISO 3166-1 alpha-2)
+   */
+  country?: string | undefined;
+  /**
+   * Maximum number of results to return
+   */
+  limit?: number | undefined;
+  /**
+   * Number of results to skip for pagination
+   */
+  offset?: number | null | undefined;
+  /**
+   * Filter by operating region name
+   */
+  operatingRegion?: string | undefined;
+  /**
+   * Filter by network operator code
+   */
+  operator?: string | undefined;
+  /**
+   * Filter by technology type (e.g. solar, wind, battery)
+   */
+  technologyType?: string | undefined;
+};
+
+/**
+ * WGS84 coordinate pair
+ */
+export type SearchECRCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const SearchECREnergyObject = {
+  EcrEntry: "ecr_entry",
+} as const;
+/**
+ * Object type identifier
+ */
+export type SearchECREnergyObject = ClosedEnum<typeof SearchECREnergyObject>;
+
+/**
+ * An entry from the Embedded Capacity Register (ECR) — a public record of all generation and storage connections to the distribution network
+ */
+export type SearchECRECREntry = {
+  /**
+   * Unique identifier for this ECR entry
+   */
+  code: string;
+  /**
+   * Date the connection was made or is expected (ISO 8601)
+   */
+  connectionDate: string | null;
+  /**
+   * Lifecycle status of a generation/storage connection. Known values: 'connected', 'accepted', 'contracted', 'in_scoping'. 'connected' is live and exporting. 'accepted' has a formal connection offer accepted. 'contracted' is under contract but not yet connected. 'in_scoping' is in early feasibility assessment. Different regulatory frameworks may define additional statuses.
+   */
+  connectionStatus: string | null;
+  /**
+   * Category of an embedded capacity register connection. Known values: 'generation', 'storage', 'generation_and_storage'. 'generation' covers solar, wind, gas, biomass, etc. 'storage' covers batteries. 'generation_and_storage' covers co-located sites. New types can be added as technologies evolve (e.g. hydrogen electrolysis, V2G).
+   */
+  connectionType: string | null;
+  /**
+   * ISO 3166-1 alpha-2 country code
+   */
+  country: string;
+  /**
+   * Maximum export capacity agreed with the network operator, in megawatts (MW)
+   */
+  exportCapacityMw: number | null;
+  /**
+   * Total installed capacity of the connection, in megawatts (MW)
+   */
+  installedCapacityMw: number | null;
+  /**
+   * WGS84 coordinate pair
+   */
+  location: SearchECRCoordinates | null;
+  /**
+   * Object type identifier
+   */
+  object: SearchECREnergyObject;
+  /**
+   * Operating region where this connection is located
+   */
+  operatingRegion: string | null;
+  /**
+   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   */
+  operator: string;
+  /**
+   * Code of the substation this connection is registered against
+   */
+  substationCode: string | null;
+  /**
+   * Technology used for generation or storage (e.g. solar, wind, battery, gas, biomass)
+   */
+  technologyType: string | null;
+};
+
+/**
+ * Object type identifier
+ */
+export const SearchECRObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type SearchECRObject = ClosedEnum<typeof SearchECRObject>;
+
+/**
+ * Paginated list response
+ */
+export type SearchECRResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<SearchECRECREntry>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: SearchECRObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type SearchECRRequest$Outbound = {
+  connectionStatus?: string | undefined;
+  country?: string | undefined;
+  limit: number;
+  offset: number | null;
+  operatingRegion?: string | undefined;
+  operator?: string | undefined;
+  technologyType?: string | undefined;
+};
+
+/** @internal */
+export const SearchECRRequest$outboundSchema: z.ZodType<
+  SearchECRRequest$Outbound,
+  z.ZodTypeDef,
+  SearchECRRequest
+> = z.object({
+  connectionStatus: z.string().optional(),
+  country: z.string().optional(),
+  limit: z.number().default(100),
+  offset: z.nullable(z.number().default(0)),
+  operatingRegion: z.string().optional(),
+  operator: z.string().optional(),
+  technologyType: z.string().optional(),
+});
+
+export function searchECRRequestToJSON(
+  searchECRRequest: SearchECRRequest,
+): string {
+  return JSON.stringify(
+    SearchECRRequest$outboundSchema.parse(searchECRRequest),
+  );
+}
+
+/** @internal */
+export const SearchECRCoordinates$inboundSchema: z.ZodType<
+  SearchECRCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function searchECRCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchECRCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchECRCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchECRCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchECREnergyObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchECREnergyObject
+> = z.nativeEnum(SearchECREnergyObject);
+
+/** @internal */
+export const SearchECRECREntry$inboundSchema: z.ZodType<
+  SearchECRECREntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  connectionDate: z.nullable(z.string()),
+  connectionStatus: z.nullable(z.string()),
+  connectionType: z.nullable(z.string()),
+  country: z.string(),
+  exportCapacityMw: z.nullable(z.number()),
+  installedCapacityMw: z.nullable(z.number()),
+  location: z.nullable(z.lazy(() => SearchECRCoordinates$inboundSchema)),
+  object: SearchECREnergyObject$inboundSchema,
+  operatingRegion: z.nullable(z.string()),
+  operator: z.string(),
+  substationCode: z.nullable(z.string()),
+  technologyType: z.nullable(z.string()),
+});
+
+export function searchECRECREntryFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchECRECREntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchECRECREntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchECRECREntry' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchECRObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchECRObject
+> = z.nativeEnum(SearchECRObject);
+
+/** @internal */
+export const SearchECRResponseBody$inboundSchema: z.ZodType<
+  SearchECRResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => SearchECRECREntry$inboundSchema)),
+  has_more: z.boolean(),
+  object: SearchECRObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function searchECRResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchECRResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchECRResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchECRResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,274 @@
+/*
+ * 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";
+
+/**
+ * Filter by rule type
+ */
+export const RuleType = {
+  Requirement: "requirement",
+  Guideline: "guideline",
+  Standard: "standard",
+  Threshold: "threshold",
+  Procedure: "procedure",
+  Definition: "definition",
+  Exemption: "exemption",
+} as const;
+/**
+ * Filter by rule type
+ */
+export type RuleType = ClosedEnum<typeof RuleType>;
+
+/**
+ * Filter by source type
+ */
+export const SourceType = {
+  NationalFramework: "national_framework",
+  LocalPlan: "local_plan",
+  SupplementaryPlanningDocument: "supplementary_planning_document",
+  DesignGuide: "design_guide",
+  NeighbourhoodPlan: "neighbourhood_plan",
+} as const;
+/**
+ * Filter by source type
+ */
+export type SourceType = ClosedEnum<typeof SourceType>;
+
+export type SearchPlanningPolicyRequest = {
+  council?: string | undefined;
+  limit?: number | undefined;
+  q: string;
+  /**
+   * Filter by rule type
+   */
+  ruleType?: RuleType | undefined;
+  /**
+   * Filter by source type
+   */
+  sourceType?: SourceType | undefined;
+};
+
+export type Meta = {
+  query: string;
+  searchTimeMs: number;
+  total: number;
+};
+
+export type Two = {
+  content: string;
+  contextSummary: string | null;
+  id: string;
+  pageEnd: number | null;
+  pageStart: number | null;
+  score: number;
+  sectionPath: Array<string> | null;
+  source: string;
+  type: "chunk";
+};
+
+export type Provenance = {
+  chapter?: string | undefined;
+  page?: number | undefined;
+  paragraph?: string | undefined;
+  section?: string | undefined;
+  source: string;
+  url?: string | undefined;
+};
+
+export type One = {
+  category: string | null;
+  confidence: number | null;
+  id: string;
+  provenance: Provenance;
+  ruleText: string;
+  ruleType: string;
+  score: number;
+  type: "rule";
+};
+
+export type Results = One | Two;
+
+/**
+ * Search results
+ */
+export type SearchPlanningPolicyResponseBody = {
+  meta: Meta;
+  results: Array<One | Two>;
+};
+
+/** @internal */
+export const RuleType$outboundSchema: z.ZodNativeEnum<typeof RuleType> = z
+  .nativeEnum(RuleType);
+
+/** @internal */
+export const SourceType$outboundSchema: z.ZodNativeEnum<typeof SourceType> = z
+  .nativeEnum(SourceType);
+
+/** @internal */
+export type SearchPlanningPolicyRequest$Outbound = {
+  council?: string | undefined;
+  limit: number;
+  q: string;
+  rule_type?: string | undefined;
+  source_type?: string | undefined;
+};
+
+/** @internal */
+export const SearchPlanningPolicyRequest$outboundSchema: z.ZodType<
+  SearchPlanningPolicyRequest$Outbound,
+  z.ZodTypeDef,
+  SearchPlanningPolicyRequest
+> = z.object({
+  council: z.string().optional(),
+  limit: z.number().int().default(10),
+  q: z.string(),
+  ruleType: RuleType$outboundSchema.optional(),
+  sourceType: SourceType$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    ruleType: "rule_type",
+    sourceType: "source_type",
+  });
+});
+
+export function searchPlanningPolicyRequestToJSON(
+  searchPlanningPolicyRequest: SearchPlanningPolicyRequest,
+): string {
+  return JSON.stringify(
+    SearchPlanningPolicyRequest$outboundSchema.parse(
+      searchPlanningPolicyRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const Meta$inboundSchema: z.ZodType<Meta, z.ZodTypeDef, unknown> = z
+  .object({
+    query: z.string(),
+    searchTimeMs: z.number(),
+    total: z.number(),
+  });
+
+export function metaFromJSON(
+  jsonString: string,
+): SafeParseResult<Meta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Meta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Meta' from JSON`,
+  );
+}
+
+/** @internal */
+export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
+  .object({
+    content: z.string(),
+    contextSummary: z.nullable(z.string()),
+    id: z.string(),
+    pageEnd: z.nullable(z.number()),
+    pageStart: z.nullable(z.number()),
+    score: z.number(),
+    sectionPath: z.nullable(z.array(z.string())),
+    source: z.string(),
+    type: z.literal("chunk"),
+  });
+
+export function twoFromJSON(
+  jsonString: string,
+): SafeParseResult<Two, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Two$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Two' from JSON`,
+  );
+}
+
+/** @internal */
+export const Provenance$inboundSchema: z.ZodType<
+  Provenance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chapter: z.string().optional(),
+  page: z.number().optional(),
+  paragraph: z.string().optional(),
+  section: z.string().optional(),
+  source: z.string(),
+  url: z.string().optional(),
+});
+
+export function provenanceFromJSON(
+  jsonString: string,
+): SafeParseResult<Provenance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Provenance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Provenance' from JSON`,
+  );
+}
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({
+    category: z.nullable(z.string()),
+    confidence: z.nullable(z.number()),
+    id: z.string(),
+    provenance: z.lazy(() => Provenance$inboundSchema),
+    ruleText: z.string(),
+    ruleType: z.string(),
+    score: z.number(),
+    type: z.literal("rule"),
+  });
+
+export function oneFromJSON(
+  jsonString: string,
+): SafeParseResult<One, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => One$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'One' from JSON`,
+  );
+}
+
+/** @internal */
+export const Results$inboundSchema: z.ZodType<Results, z.ZodTypeDef, unknown> =
+  z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]);
+
+export function resultsFromJSON(
+  jsonString: string,
+): SafeParseResult<Results, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Results$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Results' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchPlanningPolicyResponseBody$inboundSchema: z.ZodType<
+  SearchPlanningPolicyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: z.lazy(() => Meta$inboundSchema),
+  results: z.array(
+    z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]),
+  ),
+});
+
+export function searchPlanningPolicyResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchPlanningPolicyResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchPlanningPolicyResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchPlanningPolicyResponseBody' from JSON`,
+  );
+}