diff --git a/dist/openapi.json b/dist/openapi.json index 2cff0f4..16b51a7 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -983,6 +983,9 @@ }, "style": "form" }, + { + "$ref": "#/components/parameters/DatasetParam" + }, { "$ref": "#/components/parameters/ContextParam" }, @@ -3777,7 +3780,7 @@ "Dataset": { "title": "Dataset", "type": "string", - "description": "Indicates the provenance of an address.\n\n - `paf` (GBR) Postcode Address File\n - `usps` (USA) USPS Zip+4\n - `mr` (GBR) Multiple Residence File\n - `nyb` (GBR) Not Yet Built File\n - `pafa` (GBR) Alias File\n - `pafw` (GBR) Welsh File\n - `ab` (GBR) AddressBase Core\n - `ecaf` (IRL) Eircode ECAF\n - `ecad` (IRL) Eircode ECAD\n - `herewe` (Western Europe) Western Europe Dataset\n - `heret` (Taiwan) Taiwan Dataset\n - `heresa` (South America) South America Dataset\n - `hereo` (Oceania) Oceania Dataset\n - `herena` (North America) North America Dataset\n - `herei` (India) India Dataset\n - `heremea` (Middle East and Africa) Middle East and Africa Dataset\n - `herem` (Macau) Macau Dataset\n - `herehk` (Hong Kong) Hong Kong Dataset\n - `hereee` (Eastern Europe) Eastern Europe Dataset\n - `hereap` (Asia Pacific) Asia Pacific Dataset\n - `gnaf` (AUS) Geoscape Geocoded National Address File\n - `kadaster` (NLD) Kadaster BAG 2.0 Address File\n - `kartverket` (NOR) Norway Dataset\n - `sdfi` (DNK) Denmark Dataset\n - `cannar` (CAN) Canada National Address Register Dataset\n - `fodbosa` (BEL) Belgium Dataset\n - `mois` (KOR) South Korea Dataset\n - `upujp` (JPN) Japan UPU Address File\n - `bev` (AUT) Austria Dataset", + "description": "Indicates the provenance of an address.\n\n - `paf` (GBR) Postcode Address File\n - `usps` (USA) USPS Zip+4\n - `mr` (GBR) Multiple Residence File\n - `nyb` (GBR) Not Yet Built File\n - `pafa` (GBR) Alias File\n - `pafw` (GBR) Welsh File\n - `ab` (GBR) AddressBase Core\n - `ecaf` (IRL) Eircode ECAF\n - `ecad` (IRL) Eircode ECAD\n - `herewe` (Western Europe) Western Europe Dataset\n - `heret` (Taiwan) Taiwan Dataset\n - `heresa` (South America) South America Dataset\n - `hereo` (Oceania) Oceania Dataset\n - `herena` (North America) North America Dataset\n - `herei` (India) India Dataset\n - `heremea` (Middle East and Africa) Middle East and Africa Dataset\n - `herem` (Macau) Macau Dataset\n - `herehk` (Hong Kong) Hong Kong Dataset\n - `hereee` (Eastern Europe) Eastern Europe Dataset\n - `hereap` (Asia Pacific) Asia Pacific Dataset\n - `gnaf` (AUS) Geoscape Geocoded National Address File\n - `kadaster` (NLD) Kadaster BAG 2.0 Address File\n - `kartverket` (NOR) Norway Dataset\n - `sdfi` (DNK) Denmark Dataset\n - `cannar` (CAN) Canada National Address Register Dataset\n - `fodbosa` (BEL) Belgium Dataset\n - `mois` (KOR) South Korea Dataset\n - `upujp` (JPN) Japan UPU Address File", "enum": [ "paf", "pafw", @@ -3807,8 +3810,7 @@ "cannar", "fodbosa", "mois", - "upujp", - "bev" + "upujp" ] }, "CountryISO": { @@ -9583,336 +9585,6 @@ } } }, - "BevAddress": { - "required": [ - "id", - "dataset", - "country", - "country_iso", - "country_iso_2", - "language", - "address", - "line_1", - "latitude", - "longitude", - "adrcd", - "kgnr", - "gkz", - "okz", - "plz", - "skz", - "zaehlsprengel", - "hausnrtext", - "hausnrzahl1", - "hausnrbuchstabe1", - "hausnrverbindung1", - "hausnrzahl2", - "hausnrbuchstabe2", - "hausnrbereich", - "hnr_adr_zusammen", - "gnradresse", - "hofname", - "rw", - "hw", - "epsg", - "quelladresse", - "bestimmungsart", - "subcd", - "objektnummer", - "objfunktkennziffer", - "hauptadresse", - "hausnrverbindung2", - "hausnrzahl3", - "hausnrbuchstabe3", - "hausnrverbindung3", - "hausnrzahl4", - "hausnrbuchstabe4", - "hausnrgebaeudebez", - "hnr_geb_zusammen", - "eigenschaft", - "gemeindename", - "ortsname", - "strassenname", - "strassennamenzusatz", - "szusadrbest", - "zustellort", - "zustellort_id", - "zaehlsprengelname" - ], - "properties": { - "id": { - "$ref": "#/components/schemas/ID" - }, - "dataset": { - "type": "string", - "enum": [ - "bev" - ] - }, - "country_iso": { - "description": " 3 letter country code (ISO 3166-1)\n", - "enum": [ - "AUT" - ] - }, - "country_iso_2": { - "type": "string", - "description": " 2 letter country code (ISO 3166-1)\n", - "enum": [ - "AT" - ] - }, - "country": { - "type": "string", - "description": " Full country names (ISO 3166)\n", - "enum": [ - "Austria" - ] - }, - "language": { - "enum": [ - "de" - ], - "description": "Language represented by 2 letter ISO Code (639-1)\n" - }, - "address": { - "type": "string", - "description": "Combination of hnr_adr_zusammen and hnr_geb_zusammen, the full house number and text\nCan be empty string `\"\"` if not present.\n", - "example": "40" - }, - "line_1": { - "type": "string", - "description": "First address line.\nCan be empty string `\"\"` if not present.\n", - "example": "Poltenweg 40" - }, - "longitude": { - "$ref": "#/components/schemas/Longitude" - }, - "latitude": { - "$ref": "#/components/schemas/Latitude" - }, - "adrcd": { - "type": "string", - "description": "Id of the address\n" - }, - "kgnr": { - "type": "string", - "description": "Cadastral number of the municipality\n" - }, - "gkz": { - "type": "string", - "description": "Municipality code identifier\n" - }, - "okz": { - "type": "string", - "description": "Locality Code identifier\n" - }, - "plz": { - "type": "string", - "description": "Postal Code\n" - }, - "skz": { - "type": "string", - "description": "Street Code Identifier\n" - }, - "zaehlsprengel": { - "type": "string", - "description": "Census District Identifier\n" - }, - "hausnrtext": { - "type": "string", - "description": "Text before house number\n" - }, - "hausnrzahl1": { - "oneOf": [ - { - "type": "string", - "description": "Empty string `\"\"` if not available\n" - }, - { - "type": "number", - "description": "House number part 1\n" - } - ] - }, - "hausnrbuchstabe1": { - "type": "string", - "description": "House number first part of the letter\n" - }, - "hausnrverbindung1": { - "type": "string", - "description": "House number connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel\n" - }, - "hausnrzahl2": { - "oneOf": [ - { - "type": "string", - "description": "Empty string `\"\"` if not available\n" - }, - { - "type": "number", - "description": "House number part 2\n" - } - ] - }, - "hausnrbuchstabe2": { - "type": "string", - "description": "House number second part of the letter\n" - }, - "hausnrbereich": { - "type": "string", - "description": "House number valid range (only even/only odd/all) keine angabe = not specified\n" - }, - "hnr_adr_zusammen": { - "type": "string", - "description": "Complete house number (combination of house number parts and letters)\n" - }, - "gnradresse": { - "type": "number", - "description": "Property address number\n" - }, - "hofname": { - "type": "string", - "description": "The hof name is a local term for individual buildings or building complexes, such as farmsteads\n" - }, - "rw": { - "type": "string", - "description": "X coordinate (ETRS89 / LAEA Europe)\n" - }, - "hw": { - "type": "string", - "description": "Y coordinate (ETRS89 / LAEA Europe)\n" - }, - "epsg": { - "type": "number", - "description": "Coordinate reference system identifier\n" - }, - "quelladresse": { - "type": "string", - "description": "Source of the address (official survey, postal service, etc.)\n" - }, - "bestimmungsart": { - "type": "string", - "description": "Type of coordinate determination (official, customary, etc.)\n" - }, - "subcd": { - "type": "string", - "description": "Sub Code to distinguish multiple buildings at the same address\n" - }, - "objektnummer": { - "type": "string", - "description": "Object Number of the building\n" - }, - "objfunktkennziffer": { - "oneOf": [ - { - "type": "string", - "description": "Building Function Code, see ReadMe for details\n" - }, - { - "type": "string[]", - "description": "Array containing all Building Function Codes related to address\n" - } - ] - }, - "hauptadresse": { - "oneOf": [ - { - "type": "string", - "description": "Empty string `\"\"` if not available\n" - }, - { - "type": "number", - "description": "Main address, one postal per address (1 = Postal, 0 = Identification)\n" - } - ] - }, - "hausnrverbindung2": { - "type": "string", - "description": "House number 2nd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel\n" - }, - "hausnrzahl3": { - "oneOf": [ - { - "type": "string", - "description": "Empty string `\"\"` if not available\n" - }, - { - "type": "number", - "description": "House number part 3\n" - } - ] - }, - "hausnrbuchstabe3": { - "type": "string", - "description": "House number third part of the letter\n" - }, - "hausnrverbindung3": { - "type": "string", - "description": "House number 3rd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel\n" - }, - "hausnrzahl4": { - "oneOf": [ - { - "type": "string", - "description": "Empty string `\"\"` if not available\n" - }, - { - "type": "number", - "description": "House number part 4\n" - } - ] - }, - "hausnrbuchstabe4": { - "type": "string", - "description": "House number fourth part of the letter\n" - }, - "hausnrgebaeudebez": { - "type": "string", - "description": "Building distinction (e.g., \"House\", \"Building\", \"Villa\", etc.)\n" - }, - "hnr_geb_zusammen": { - "type": "string", - "description": "Full building designation (combination of house number and building designation)\n" - }, - "eigenschaft": { - "type": "string", - "description": "Prominent feature of the property (See ReadMe for details)\n" - }, - "gemeindename": { - "type": "string", - "description": "Name of the municipality\n" - }, - "ortsname": { - "type": "string", - "description": "Name of the locality\n" - }, - "strassenname": { - "type": "string", - "description": "Name of the street\n" - }, - "strassennamenzusatz": { - "type": "string", - "description": "Street name addition (e.g., \"Allee\", \"Strasse\", etc.)\n" - }, - "szusadrbest": { - "type": "number", - "description": "Number of addresses associated with the street\n" - }, - "zustellort": { - "type": "string", - "description": "Delivery location (usually the same as the street name)\n" - }, - "zustellort_id": { - "type": "string", - "description": "Delivery location code identifier\n" - }, - "zaehlsprengelname": { - "type": "string", - "description": "Census District Identifier\n" - } - } - }, "GbrGlobalAddress": { "title": "Global Address", "description": "Global (non-UK) address in the UK address format", @@ -10062,9 +9734,6 @@ }, { "$ref": "#/components/schemas/UpujpAddress" - }, - { - "$ref": "#/components/schemas/BevAddress" } ] }, @@ -10831,8 +10500,7 @@ "cannar", "fodbosa", "mois", - "upujp", - "bev" + "upujp" ], "properties": { "paf": { @@ -10993,11 +10661,6 @@ "type": "boolean", "description": "Japan: UPU Address File", "example": true - }, - "bev": { - "type": "boolean", - "description": "Austria: BEV Address File", - "example": true } } }, @@ -11341,11 +11004,6 @@ "type": "boolean", "description": "Japan: UPU Address File", "example": true - }, - "bev": { - "type": "boolean", - "description": "Austria: BEV Address File", - "example": true } } } @@ -12906,9 +12564,6 @@ }, { "$ref": "#/components/schemas/UpujpAddress" - }, - { - "$ref": "#/components/schemas/BevAddress" } ] } @@ -14470,6 +14125,20 @@ }, "style": "form" }, + "DatasetParam": { + "name": "dataset", + "in": "query", + "style": "form", + "explode": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Dataset" + } + }, + "description": "**Filter by Dataset**\n\nComma-separated list of datasets to search within.\n\nFilters autocomplete results to only include addresses from the specified datasets.\n", + "example": "paf,nyb" + }, "ContextParam": { "name": "context", "in": "query", diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 417689d..1c797d3 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -987,6 +987,7 @@ paths: type: string maxLength: 150 style: form + - $ref: '#/components/parameters/DatasetParam' - $ref: '#/components/parameters/ContextParam' - $ref: '#/components/parameters/LimitParam' - $ref: '#/components/parameters/BiasLonLatParam' @@ -3139,7 +3140,6 @@ components: - `fodbosa` (BEL) Belgium Dataset - `mois` (KOR) South Korea Dataset - `upujp` (JPN) Japan UPU Address File - - `bev` (AUT) Austria Dataset enum: - paf - pafw @@ -3170,7 +3170,6 @@ components: - fodbosa - mois - upujp - - bev CountryISO: title: ISO Country Code (3) type: string @@ -9257,302 +9256,6 @@ components: Language used for the locality names. Can be empty string `""` if not present. - BevAddress: - required: - - id - - dataset - - country - - country_iso - - country_iso_2 - - language - - address - - line_1 - - latitude - - longitude - - adrcd - - kgnr - - gkz - - okz - - plz - - skz - - zaehlsprengel - - hausnrtext - - hausnrzahl1 - - hausnrbuchstabe1 - - hausnrverbindung1 - - hausnrzahl2 - - hausnrbuchstabe2 - - hausnrbereich - - hnr_adr_zusammen - - gnradresse - - hofname - - rw - - hw - - epsg - - quelladresse - - bestimmungsart - - subcd - - objektnummer - - objfunktkennziffer - - hauptadresse - - hausnrverbindung2 - - hausnrzahl3 - - hausnrbuchstabe3 - - hausnrverbindung3 - - hausnrzahl4 - - hausnrbuchstabe4 - - hausnrgebaeudebez - - hnr_geb_zusammen - - eigenschaft - - gemeindename - - ortsname - - strassenname - - strassennamenzusatz - - szusadrbest - - zustellort - - zustellort_id - - zaehlsprengelname - properties: - id: - $ref: '#/components/schemas/ID' - dataset: - type: string - enum: - - bev - country_iso: - description: |2 - 3 letter country code (ISO 3166-1) - enum: - - AUT - country_iso_2: - type: string - description: |2 - 2 letter country code (ISO 3166-1) - enum: - - AT - country: - type: string - description: |2 - Full country names (ISO 3166) - enum: - - Austria - language: - enum: - - de - description: | - Language represented by 2 letter ISO Code (639-1) - address: - type: string - description: | - Combination of hnr_adr_zusammen and hnr_geb_zusammen, the full house number and text - Can be empty string `""` if not present. - example: '40' - line_1: - type: string - description: | - First address line. - Can be empty string `""` if not present. - example: Poltenweg 40 - longitude: - $ref: '#/components/schemas/Longitude' - latitude: - $ref: '#/components/schemas/Latitude' - adrcd: - type: string - description: | - Id of the address - kgnr: - type: string - description: | - Cadastral number of the municipality - gkz: - type: string - description: | - Municipality code identifier - okz: - type: string - description: | - Locality Code identifier - plz: - type: string - description: | - Postal Code - skz: - type: string - description: | - Street Code Identifier - zaehlsprengel: - type: string - description: | - Census District Identifier - hausnrtext: - type: string - description: | - Text before house number - hausnrzahl1: - oneOf: - - type: string - description: | - Empty string `""` if not available - - type: number - description: | - House number part 1 - hausnrbuchstabe1: - type: string - description: | - House number first part of the letter - hausnrverbindung1: - type: string - description: | - House number connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel - hausnrzahl2: - oneOf: - - type: string - description: | - Empty string `""` if not available - - type: number - description: | - House number part 2 - hausnrbuchstabe2: - type: string - description: | - House number second part of the letter - hausnrbereich: - type: string - description: | - House number valid range (only even/only odd/all) keine angabe = not specified - hnr_adr_zusammen: - type: string - description: | - Complete house number (combination of house number parts and letters) - gnradresse: - type: number - description: | - Property address number - hofname: - type: string - description: | - The hof name is a local term for individual buildings or building complexes, such as farmsteads - rw: - type: string - description: | - X coordinate (ETRS89 / LAEA Europe) - hw: - type: string - description: | - Y coordinate (ETRS89 / LAEA Europe) - epsg: - type: number - description: | - Coordinate reference system identifier - quelladresse: - type: string - description: | - Source of the address (official survey, postal service, etc.) - bestimmungsart: - type: string - description: | - Type of coordinate determination (official, customary, etc.) - subcd: - type: string - description: | - Sub Code to distinguish multiple buildings at the same address - objektnummer: - type: string - description: | - Object Number of the building - objfunktkennziffer: - oneOf: - - type: string - description: | - Building Function Code, see ReadMe for details - - type: string[] - description: | - Array containing all Building Function Codes related to address - hauptadresse: - oneOf: - - type: string - description: | - Empty string `""` if not available - - type: number - description: | - Main address, one postal per address (1 = Postal, 0 = Identification) - hausnrverbindung2: - type: string - description: | - House number 2nd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel - hausnrzahl3: - oneOf: - - type: string - description: | - Empty string `""` if not available - - type: number - description: | - House number part 3 - hausnrbuchstabe3: - type: string - description: | - House number third part of the letter - hausnrverbindung3: - type: string - description: | - House number 3rd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel - hausnrzahl4: - oneOf: - - type: string - description: | - Empty string `""` if not available - - type: number - description: | - House number part 4 - hausnrbuchstabe4: - type: string - description: | - House number fourth part of the letter - hausnrgebaeudebez: - type: string - description: | - Building distinction (e.g., "House", "Building", "Villa", etc.) - hnr_geb_zusammen: - type: string - description: | - Full building designation (combination of house number and building designation) - eigenschaft: - type: string - description: | - Prominent feature of the property (See ReadMe for details) - gemeindename: - type: string - description: | - Name of the municipality - ortsname: - type: string - description: | - Name of the locality - strassenname: - type: string - description: | - Name of the street - strassennamenzusatz: - type: string - description: | - Street name addition (e.g., "Allee", "Strasse", etc.) - szusadrbest: - type: number - description: | - Number of addresses associated with the street - zustellort: - type: string - description: | - Delivery location (usually the same as the street name) - zustellort_id: - type: string - description: | - Delivery location code identifier - zaehlsprengelname: - type: string - description: | - Census District Identifier GbrGlobalAddress: title: Global Address description: Global (non-UK) address in the UK address format @@ -9664,7 +9367,6 @@ components: - $ref: '#/components/schemas/FodbosaAddress' - $ref: '#/components/schemas/MoisAddress' - $ref: '#/components/schemas/UpujpAddress' - - $ref: '#/components/schemas/BevAddress' postcode_outward: type: string description: Not available for non-UK addresses @@ -10269,7 +9971,6 @@ components: - fodbosa - mois - upujp - - bev properties: paf: type: boolean @@ -10398,10 +10099,6 @@ components: type: boolean description: 'Japan: UPU Address File' example: true - bev: - type: boolean - description: 'Austria: BEV Address File' - example: true ApiKeyAutomatedTopup: title: API Key Automated Topup description: Automated topup status @@ -10679,10 +10376,6 @@ components: type: boolean description: 'Japan: UPU Address File' example: true - bev: - type: boolean - description: 'Austria: BEV Address File' - example: true KeyUsageResult: title: Key Usage type: object @@ -11932,7 +11625,6 @@ components: - $ref: '#/components/schemas/FodbosaAddress' - $ref: '#/components/schemas/MoisAddress' - $ref: '#/components/schemas/UpujpAddress' - - $ref: '#/components/schemas/BevAddress' UsaResolveAddressResponse: title: Address Retrieve Response (USA) type: object @@ -13197,6 +12889,22 @@ components: schema: type: string style: form + DatasetParam: + name: dataset + in: query + style: form + explode: false + schema: + type: array + items: + $ref: '#/components/schemas/Dataset' + description: | + **Filter by Dataset** + + Comma-separated list of datasets to search within. + + Filters autocomplete results to only include addresses from the specified datasets. + example: paf,nyb ContextParam: name: context in: query diff --git a/openapi.ts b/openapi.ts index 6a6d50a..e242f21 100644 --- a/openapi.ts +++ b/openapi.ts @@ -1134,7 +1134,6 @@ export interface components { * - `fodbosa` (BEL) Belgium Dataset * - `mois` (KOR) South Korea Dataset * - `upujp` (JPN) Japan UPU Address File - * - `bev` (AUT) Austria Dataset * @enum {string} */ Dataset: @@ -1166,8 +1165,7 @@ export interface components { | "cannar" | "fodbosa" | "mois" - | "upujp" - | "bev"; + | "upujp"; /** * ISO Country Code (3) * @description 3 letter country code (ISO 3166-1) @@ -5737,131 +5735,6 @@ export interface components { } & { script: unknown; }; - BevAddress: { - id: components["schemas"]["ID"]; - /** @enum {string} */ - dataset: "bev"; - /** - * @description 3 letter country code (ISO 3166-1) - * - * @enum {undefined} - */ - country_iso: "AUT"; - /** - * @description 2 letter country code (ISO 3166-1) - * - * @enum {string} - */ - country_iso_2: "AT"; - /** - * @description Full country names (ISO 3166) - * - * @enum {string} - */ - country: "Austria"; - /** - * @description Language represented by 2 letter ISO Code (639-1) - * - * @enum {undefined} - */ - language: "de"; - /** - * @description Combination of hnr_adr_zusammen and hnr_geb_zusammen, the full house number and text - * Can be empty string `""` if not present. - * - * @example 40 - */ - address: string; - /** - * @description First address line. - * Can be empty string `""` if not present. - * - * @example Poltenweg 40 - */ - line_1: string; - longitude: components["schemas"]["Longitude"]; - latitude: components["schemas"]["Latitude"]; - /** @description Id of the address */ - adrcd: string; - /** @description Cadastral number of the municipality */ - kgnr: string; - /** @description Municipality code identifier */ - gkz: string; - /** @description Locality Code identifier */ - okz: string; - /** @description Postal Code */ - plz: string; - /** @description Street Code Identifier */ - skz: string; - /** @description Census District Identifier */ - zaehlsprengel: string; - /** @description Text before house number */ - hausnrtext: string; - hausnrzahl1: string | number; - /** @description House number first part of the letter */ - hausnrbuchstabe1: string; - /** @description House number connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel */ - hausnrverbindung1: string; - hausnrzahl2: string | number; - /** @description House number second part of the letter */ - hausnrbuchstabe2: string; - /** @description House number valid range (only even/only odd/all) keine angabe = not specified */ - hausnrbereich: string; - /** @description Complete house number (combination of house number parts and letters) */ - hnr_adr_zusammen: string; - /** @description Property address number */ - gnradresse: number; - /** @description The hof name is a local term for individual buildings or building complexes, such as farmsteads */ - hofname: string; - /** @description X coordinate (ETRS89 / LAEA Europe) */ - rw: string; - /** @description Y coordinate (ETRS89 / LAEA Europe) */ - hw: string; - /** @description Coordinate reference system identifier */ - epsg: number; - /** @description Source of the address (official survey, postal service, etc.) */ - quelladresse: string; - /** @description Type of coordinate determination (official, customary, etc.) */ - bestimmungsart: string; - /** @description Sub Code to distinguish multiple buildings at the same address */ - subcd: string; - /** @description Object Number of the building */ - objektnummer: string; - objfunktkennziffer: string | unknown; - hauptadresse: string | number; - /** @description House number 2nd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel */ - hausnrverbindung2: string; - hausnrzahl3: string | number; - /** @description House number third part of the letter */ - hausnrbuchstabe3: string; - /** @description House number 3rd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel */ - hausnrverbindung3: string; - hausnrzahl4: string | number; - /** @description House number fourth part of the letter */ - hausnrbuchstabe4: string; - /** @description Building distinction (e.g., "House", "Building", "Villa", etc.) */ - hausnrgebaeudebez: string; - /** @description Full building designation (combination of house number and building designation) */ - hnr_geb_zusammen: string; - /** @description Prominent feature of the property (See ReadMe for details) */ - eigenschaft: string; - /** @description Name of the municipality */ - gemeindename: string; - /** @description Name of the locality */ - ortsname: string; - /** @description Name of the street */ - strassenname: string; - /** @description Street name addition (e.g., "Allee", "Strasse", etc.) */ - strassennamenzusatz: string; - /** @description Number of addresses associated with the street */ - szusadrbest: number; - /** @description Delivery location (usually the same as the street name) */ - zustellort: string; - /** @description Delivery location code identifier */ - zustellort_id: string; - /** @description Census District Identifier */ - zaehlsprengelname: string; - }; /** * Global Address * @description Global (non-UK) address in the UK address format @@ -5928,8 +5801,7 @@ export interface components { | components["schemas"]["CannarAddress"] | components["schemas"]["FodbosaAddress"] | components["schemas"]["MoisAddress"] - | components["schemas"]["UpujpAddress"] - | components["schemas"]["BevAddress"]; + | components["schemas"]["UpujpAddress"]; /** * @description Not available for non-UK addresses * @enum {string} @@ -6579,11 +6451,6 @@ export interface components { * @example true */ upujp: boolean; - /** - * @description Austria: BEV Address File - * @example true - */ - bev: boolean; }; /** * API Key Automated Topup @@ -6829,11 +6696,6 @@ export interface components { * @example true */ upujp?: boolean; - /** - * @description Austria: BEV Address File - * @example true - */ - bev?: boolean; }; }; /** Key Usage */ @@ -7782,8 +7644,7 @@ export interface components { | components["schemas"]["CannarAddress"] | components["schemas"]["FodbosaAddress"] | components["schemas"]["MoisAddress"] - | components["schemas"]["UpujpAddress"] - | components["schemas"]["BevAddress"]; + | components["schemas"]["UpujpAddress"]; }; /** Address Retrieve Response (USA) */ UsaResolveAddressResponse: { @@ -8762,6 +8623,16 @@ export interface components { * @example sl_hk71kco54zGSGvF9eXXrvvnMOLLNh */ LicenseeParam: string; + /** + * @description **Filter by Dataset** + * + * Comma-separated list of datasets to search within. + * + * Filters autocomplete results to only include addresses from the specified datasets. + * + * @example paf,nyb + */ + DatasetParam: components["schemas"]["Dataset"][]; /** * @description **Context** * @@ -9771,6 +9642,14 @@ export interface operations { * The partial address string entered by the user to autocomplete. */ query?: string; + /** + * **Filter by Dataset** + * + * Comma-separated list of datasets to search within. + * + * Filters autocomplete results to only include addresses from the specified datasets. + */ + dataset?: components["parameters"]["DatasetParam"]; /** * **Context** *