@viadukt/connect 2.12.0-next.2 → 2.13.0-next.1

package/dist/index.d.ts

@@ -1231,6 +1231,133 @@ declare const $ParcelPropertiesV4: {
     };
     readonly required: readonly ["parcel_id", "total_area", "developed_area", "free_area"];
 };
+declare const $Position3D: {
+    readonly type: "array";
+    readonly prefixItems: readonly [{
+        readonly type: "number";
+    }, {
+        readonly type: "number";
+    }, {
+        readonly type: "number";
+    }];
+};
+declare const $Polygon3DGeometry: {
+    readonly type: "object";
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["Polygon"];
+        };
+        readonly coordinates: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "array";
+                readonly items: {
+                    readonly $ref: "#/components/schemas/Position3D";
+                };
+            };
+        };
+    };
+    readonly required: readonly ["type", "coordinates"];
+};
+declare const $MultiPolygon3DGeometry: {
+    readonly type: "object";
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["MultiPolygon"];
+        };
+        readonly coordinates: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/components/schemas/Position3D";
+                    };
+                };
+            };
+        };
+    };
+    readonly required: readonly ["type", "coordinates"];
+};
+declare const $GeometryCollection3D: {
+    readonly type: "object";
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["GeometryCollection"];
+        };
+        readonly geometries: {
+            readonly type: "array";
+            readonly items: {
+                readonly anyOf: readonly [{
+                    readonly $ref: "#/components/schemas/Polygon3DGeometry";
+                }, {
+                    readonly $ref: "#/components/schemas/MultiPolygon3DGeometry";
+                }];
+            };
+        };
+    };
+    readonly required: readonly ["type", "geometries"];
+};
+declare const $Geometry3D: {
+    readonly anyOf: readonly [{
+        readonly $ref: "#/components/schemas/Polygon3DGeometry";
+    }, {
+        readonly $ref: "#/components/schemas/MultiPolygon3DGeometry";
+    }, {
+        readonly $ref: "#/components/schemas/GeometryCollection3D";
+    }];
+};
+declare const $SurfaceType: {
+    readonly type: "string";
+    readonly enum: readonly ["wall", "ground", "roof"];
+    readonly description: "The surface type of this geometry (wall, ground, or roof)";
+    readonly example: "roof";
+};
+declare const $BuildingGeometryPropertiesV4: {
+    readonly type: "object";
+    readonly properties: {
+        readonly type: {
+            readonly $ref: "#/components/schemas/SurfaceType";
+        };
+    };
+    readonly required: readonly ["type"];
+};
+declare const $BuildingGeometryFeatureV4: {
+    readonly type: "object";
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["Feature"];
+        };
+        readonly geometry: {
+            readonly $ref: "#/components/schemas/Geometry3D";
+        };
+        readonly properties: {
+            readonly $ref: "#/components/schemas/BuildingGeometryPropertiesV4";
+        };
+    };
+    readonly required: readonly ["type", "geometry", "properties"];
+};
+declare const $BuildingGeometryResponseV4: {
+    readonly type: "object";
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["FeatureCollection"];
+        };
+        readonly features: {
+            readonly type: "array";
+            readonly items: {
+                readonly $ref: "#/components/schemas/BuildingGeometryFeatureV4";
+            };
+        };
+    };
+    readonly required: readonly ["type", "features"];
+};
 
 type LookupPropertiesV2 = {
     /**
@@ -3226,6 +3353,41 @@ type ParcelPropertiesV4 = {
      */
     free_area: number | null;
 };
+type Position3D = unknown[];
+type Polygon3DGeometry = {
+    type: 'Polygon';
+    coordinates: Array<Array<Position3D>>;
+};
+type type2 = 'Polygon';
+type MultiPolygon3DGeometry = {
+    type: 'MultiPolygon';
+    coordinates: Array<Array<Array<Position3D>>>;
+};
+type type3 = 'MultiPolygon';
+type GeometryCollection3D = {
+    type: 'GeometryCollection';
+    geometries: Array<(Polygon3DGeometry | MultiPolygon3DGeometry)>;
+};
+type type4 = 'GeometryCollection';
+type Geometry3D = Polygon3DGeometry | MultiPolygon3DGeometry | GeometryCollection3D;
+/**
+ * The surface type of this geometry (wall, ground, or roof)
+ */
+type SurfaceType = 'wall' | 'ground' | 'roof';
+type BuildingGeometryPropertiesV4 = {
+    type: SurfaceType;
+};
+type BuildingGeometryFeatureV4 = {
+    type: 'Feature';
+    geometry: Geometry3D;
+    properties: BuildingGeometryPropertiesV4;
+};
+type type5 = 'Feature';
+type BuildingGeometryResponseV4 = {
+    type: 'FeatureCollection';
+    features: Array<BuildingGeometryFeatureV4>;
+};
+type type6 = 'FeatureCollection';
 type GetAddressLookupV2Data = {
     query: {
         city: string;
@@ -3423,6 +3585,14 @@ type GetParcelCoordinateLookupV4Response = {
     }>;
 };
 type GetParcelCoordinateLookupV4Error = unknown;
+type GetBuildingPart3dGeometryLookupV4Data = {
+    query: {
+        building_id: string;
+        grouping_strategy?: 'proximity' | 'property';
+    };
+};
+type GetBuildingPart3dGeometryLookupV4Response = BuildingGeometryResponseV4;
+type GetBuildingPart3dGeometryLookupV4Error = unknown;
 type $OpenApiTs = {
     '/v2/addressLookup': {
         get: {
@@ -3849,6 +4019,44 @@ type $OpenApiTs = {
             };
         };
     };
+    '/v4/buildingPart3dGeometryLookup': {
+        get: {
+            req: GetBuildingPart3dGeometryLookupV4Data;
+            res: {
+                /**
+                 *
+                 * Retrieves the 3D building part geometries for the group that contains the given building identifier.
+                 * The response includes wall, roof, and ground surface geometries as individual Features in a FeatureCollection.
+                 *
+                 */
+                '200': BuildingGeometryResponseV4;
+                /**
+                 * Invalid or missing building_id
+                 */
+                '400': {
+                    error: string;
+                };
+                /**
+                 * Unauthorized access
+                 */
+                '401': {
+                    error: string;
+                };
+                /**
+                 * Building not found
+                 */
+                '404': {
+                    error: string;
+                };
+                /**
+                 * Internal server error
+                 */
+                '500': {
+                    error: string;
+                };
+            };
+        };
+    };
 };
 
 /**
@@ -4168,5 +4376,41 @@ declare const getParcelCoordinateLookupV4: (options?: Options<GetParcelCoordinat
     request: Request;
     response: Response;
 }>;
+/**
+ * Retrieve 3D building part geometries for the group of a building
+ *
+ * This endpoint retrieves the 3D building part geometries for the group that contains the queried building.
+ * The data includes wall, roof, and ground surface geometries as individual GeoJSON Features with
+ * 3D coordinates (longitude, latitude, altitude).
+ *
+ * ### New in v4
+ * This is a new endpoint in v4 dedicated to 3D building geometry retrieval. Each building is decomposed
+ * into its constituent surfaces — walls, roofs, and ground planes — each returned as a separate Feature
+ * with a `type` property indicating the surface kind.
+ *
+ * ### Permissions
+ * - `api.lookup.building.geometry.read`: This permission grants the ability to
+ * read and retrieve 3D building part geometries for a given building identifier.
+ *
+ * ### Grouping Strategy
+ * This endpoint resolves the full building group for the queried building using the selected grouping strategy:
+ * - `proximity` (default) — geometry-based spatial clustering via `gold__proximity_groups`
+ * - `property` — cadastral address-based grouping via `gold__property_groups`
+ *
+ * It then returns 3D geometries for all buildings in that resolved group, not only the single queried building. This enables rendering complete building clusters in 3D.
+ *
+ * ### Response Structure
+ * - **GeoJSON Type**: The response returns a `FeatureCollection` containing all geometry parts
+ * for the requested building.
+ * - **Properties**: Each Feature includes a `type` property with value `wall`, `ground`, or `roof`.
+ * - **Geometry**: Contains 3D Polygon coordinates in WGS84 (EPSG:4326) with altitude values as the
+ * third coordinate element `[longitude, latitude, altitude]`.
+ */
+declare const getBuildingPart3dGeometryLookupV4: (options: Options<GetBuildingPart3dGeometryLookupV4Data>) => Promise<{
+    error?: unknown;
+    data?: BuildingGeometryResponseV4 | undefined;
+    request: Request;
+    response: Response;
+}>;
 
-export { $LookupPropertiesV2, $LookupPropertiesV3, type $OpenApiTs, $ParcelPropertiesV4, type GetAddressLookupV2Data, type GetAddressLookupV2Error, type GetAddressLookupV2Response, type GetAddressLookupV3Data, type GetAddressLookupV3Error, type GetAddressLookupV3Response, type GetCoordinateLookupV2Data, type GetCoordinateLookupV2Error, type GetCoordinateLookupV2Response, type GetCoordinateLookupV3Data, type GetCoordinateLookupV3Error, type GetCoordinateLookupV3Response, type GetParcelCoordinateLookupV4Data, type GetParcelCoordinateLookupV4Error, type GetParcelCoordinateLookupV4Response, type LookupPropertiesV2, type LookupPropertiesV3, type ParcelPropertiesV4, type PostCoordinateBatchLookupV2Data, type PostCoordinateBatchLookupV2Error, type PostCoordinateBatchLookupV2Response, type PostCoordinateBatchLookupV3Data, type PostCoordinateBatchLookupV3Error, type PostCoordinateBatchLookupV3Response, type building_function_class, type characteristics, type development_layout, type dominant, type environment, getAddressLookupV2, getAddressLookupV3, getCoordinateLookupV2, getCoordinateLookupV3, getParcelCoordinateLookupV4, type governance, type grouping_strategy, type height_category, type investment_perspective, type milieus_dominant, type modernisation_potential, type overall, postCoordinateBatchLookupV2, postCoordinateBatchLookupV3, type roof_type, type social, type type, type usage };
+export { $BuildingGeometryFeatureV4, $BuildingGeometryPropertiesV4, $BuildingGeometryResponseV4, $Geometry3D, $GeometryCollection3D, $LookupPropertiesV2, $LookupPropertiesV3, $MultiPolygon3DGeometry, type $OpenApiTs, $ParcelPropertiesV4, $Polygon3DGeometry, $Position3D, $SurfaceType, type BuildingGeometryFeatureV4, type BuildingGeometryPropertiesV4, type BuildingGeometryResponseV4, type Geometry3D, type GeometryCollection3D, type GetAddressLookupV2Data, type GetAddressLookupV2Error, type GetAddressLookupV2Response, type GetAddressLookupV3Data, type GetAddressLookupV3Error, type GetAddressLookupV3Response, type GetBuildingPart3dGeometryLookupV4Data, type GetBuildingPart3dGeometryLookupV4Error, type GetBuildingPart3dGeometryLookupV4Response, type GetCoordinateLookupV2Data, type GetCoordinateLookupV2Error, type GetCoordinateLookupV2Response, type GetCoordinateLookupV3Data, type GetCoordinateLookupV3Error, type GetCoordinateLookupV3Response, type GetParcelCoordinateLookupV4Data, type GetParcelCoordinateLookupV4Error, type GetParcelCoordinateLookupV4Response, type LookupPropertiesV2, type LookupPropertiesV3, type MultiPolygon3DGeometry, type ParcelPropertiesV4, type Polygon3DGeometry, type Position3D, type PostCoordinateBatchLookupV2Data, type PostCoordinateBatchLookupV2Error, type PostCoordinateBatchLookupV2Response, type PostCoordinateBatchLookupV3Data, type PostCoordinateBatchLookupV3Error, type PostCoordinateBatchLookupV3Response, type SurfaceType, type building_function_class, type characteristics, type development_layout, type dominant, type environment, getAddressLookupV2, getAddressLookupV3, getBuildingPart3dGeometryLookupV4, getCoordinateLookupV2, getCoordinateLookupV3, getParcelCoordinateLookupV4, type governance, type grouping_strategy, type height_category, type investment_perspective, type milieus_dominant, type modernisation_potential, type overall, postCoordinateBatchLookupV2, postCoordinateBatchLookupV3, type roof_type, type social, type type, type type2, type type3, type type4, type type5, type type6, type usage };

package/dist/index.js

@@ -2274,6 +2274,144 @@ The field is set to \`null\` if the free area is unknown.`,
   },
   required: ["parcel_id", "total_area", "developed_area", "free_area"]
 };
+var $Position3D = {
+  type: "array",
+  prefixItems: [
+    {
+      type: "number"
+    },
+    {
+      type: "number"
+    },
+    {
+      type: "number"
+    }
+  ]
+};
+var $Polygon3DGeometry = {
+  type: "object",
+  properties: {
+    type: {
+      type: "string",
+      enum: ["Polygon"]
+    },
+    coordinates: {
+      type: "array",
+      items: {
+        type: "array",
+        items: {
+          "$ref": "#/components/schemas/Position3D"
+        }
+      }
+    }
+  },
+  required: ["type", "coordinates"]
+};
+var $MultiPolygon3DGeometry = {
+  type: "object",
+  properties: {
+    type: {
+      type: "string",
+      enum: ["MultiPolygon"]
+    },
+    coordinates: {
+      type: "array",
+      items: {
+        type: "array",
+        items: {
+          type: "array",
+          items: {
+            "$ref": "#/components/schemas/Position3D"
+          }
+        }
+      }
+    }
+  },
+  required: ["type", "coordinates"]
+};
+var $GeometryCollection3D = {
+  type: "object",
+  properties: {
+    type: {
+      type: "string",
+      enum: ["GeometryCollection"]
+    },
+    geometries: {
+      type: "array",
+      items: {
+        anyOf: [
+          {
+            "$ref": "#/components/schemas/Polygon3DGeometry"
+          },
+          {
+            "$ref": "#/components/schemas/MultiPolygon3DGeometry"
+          }
+        ]
+      }
+    }
+  },
+  required: ["type", "geometries"]
+};
+var $Geometry3D = {
+  anyOf: [
+    {
+      "$ref": "#/components/schemas/Polygon3DGeometry"
+    },
+    {
+      "$ref": "#/components/schemas/MultiPolygon3DGeometry"
+    },
+    {
+      "$ref": "#/components/schemas/GeometryCollection3D"
+    }
+  ]
+};
+var $SurfaceType = {
+  type: "string",
+  enum: ["wall", "ground", "roof"],
+  description: "The surface type of this geometry (wall, ground, or roof)",
+  example: "roof"
+};
+var $BuildingGeometryPropertiesV4 = {
+  type: "object",
+  properties: {
+    type: {
+      "$ref": "#/components/schemas/SurfaceType"
+    }
+  },
+  required: ["type"]
+};
+var $BuildingGeometryFeatureV4 = {
+  type: "object",
+  properties: {
+    type: {
+      type: "string",
+      enum: ["Feature"]
+    },
+    geometry: {
+      "$ref": "#/components/schemas/Geometry3D"
+    },
+    properties: {
+      "$ref": "#/components/schemas/BuildingGeometryPropertiesV4"
+    }
+  },
+  required: ["type", "geometry", "properties"]
+};
+var $BuildingGeometryResponseV4 = {
+  type: "object",
+  properties: {
+    type: {
+      type: "string",
+      enum: ["FeatureCollection"]
+    },
+    features: {
+      type: "array",
+      items: {
+        "$ref": "#/components/schemas/BuildingGeometryFeatureV4"
+      }
+    }
+  },
+  required: ["type", "features"]
+};
 
 // src/services.gen.ts
 import { client } from "@hey-api/client-fetch";
@@ -2319,16 +2457,32 @@ var getParcelCoordinateLookupV4 = (options) => {
     url: "/v4/parcelCoordinateLookup"
   }));
 };
+var getBuildingPart3dGeometryLookupV4 = (options) => {
+  var _a;
+  return ((_a = options == null ? void 0 : options.client) != null ? _a : client).get(__spreadProps(__spreadValues({}, options), {
+    url: "/v4/buildingPart3dGeometryLookup"
+  }));
+};
 
 // src/index.ts
 import { createClient } from "@hey-api/client-fetch";
 export {
+  $BuildingGeometryFeatureV4,
+  $BuildingGeometryPropertiesV4,
+  $BuildingGeometryResponseV4,
+  $Geometry3D,
+  $GeometryCollection3D,
   $LookupPropertiesV2,
   $LookupPropertiesV3,
+  $MultiPolygon3DGeometry,
   $ParcelPropertiesV4,
+  $Polygon3DGeometry,
+  $Position3D,
+  $SurfaceType,
   createClient,
   getAddressLookupV2,
   getAddressLookupV3,
+  getBuildingPart3dGeometryLookupV4,
   getCoordinateLookupV2,
   getCoordinateLookupV3,
   getParcelCoordinateLookupV4,