@vepler/sdk 2.164.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +408 -401
- package/dist/commonjs/address-search/__tests__/controller.test.d.ts +2 -0
- package/dist/commonjs/address-search/__tests__/controller.test.d.ts.map +1 -0
- package/dist/commonjs/address-search/__tests__/controller.test.js +329 -0
- package/dist/commonjs/address-search/__tests__/controller.test.js.map +1 -0
- package/dist/commonjs/address-search/__tests__/default-transports.test.d.ts +2 -0
- package/dist/commonjs/address-search/__tests__/default-transports.test.d.ts.map +1 -0
- package/dist/commonjs/address-search/__tests__/default-transports.test.js +161 -0
- package/dist/commonjs/address-search/__tests__/default-transports.test.js.map +1 -0
- package/dist/commonjs/address-search/__tests__/narrow.test.d.ts +2 -0
- package/dist/commonjs/address-search/__tests__/narrow.test.d.ts.map +1 -0
- package/dist/commonjs/address-search/__tests__/narrow.test.js +63 -0
- package/dist/commonjs/address-search/__tests__/narrow.test.js.map +1 -0
- package/dist/commonjs/address-search/controller.d.ts +14 -0
- package/dist/commonjs/address-search/controller.d.ts.map +1 -0
- package/dist/commonjs/address-search/controller.js +190 -0
- package/dist/commonjs/address-search/controller.js.map +1 -0
- package/dist/commonjs/address-search/default-transports.d.ts +52 -0
- package/dist/commonjs/address-search/default-transports.d.ts.map +1 -0
- package/dist/commonjs/address-search/default-transports.js +134 -0
- package/dist/commonjs/address-search/default-transports.js.map +1 -0
- package/dist/commonjs/address-search/errors.d.ts +5 -0
- package/dist/commonjs/address-search/errors.d.ts.map +1 -0
- package/dist/commonjs/address-search/errors.js +12 -0
- package/dist/commonjs/address-search/errors.js.map +1 -0
- package/dist/commonjs/address-search/index.d.ts +8 -0
- package/dist/commonjs/address-search/index.d.ts.map +1 -0
- package/dist/commonjs/address-search/index.js +43 -0
- package/dist/commonjs/address-search/index.js.map +1 -0
- package/dist/commonjs/address-search/lru-cache.d.ts +13 -0
- package/dist/commonjs/address-search/lru-cache.d.ts.map +1 -0
- package/dist/commonjs/address-search/lru-cache.js +50 -0
- package/dist/commonjs/address-search/lru-cache.js.map +1 -0
- package/dist/commonjs/address-search/narrow.d.ts +21 -0
- package/dist/commonjs/address-search/narrow.d.ts.map +1 -0
- package/dist/commonjs/address-search/narrow.js +49 -0
- package/dist/commonjs/address-search/narrow.js.map +1 -0
- package/dist/commonjs/address-search/types.d.ts +125 -0
- package/dist/commonjs/address-search/types.d.ts.map +1 -0
- package/dist/commonjs/address-search/types.js +9 -0
- package/dist/commonjs/address-search/types.js.map +1 -0
- package/dist/commonjs/address-search.d.ts +3 -0
- package/dist/commonjs/address-search.d.ts.map +1 -0
- package/dist/commonjs/address-search.js +19 -0
- package/dist/commonjs/address-search.js.map +1 -0
- package/dist/commonjs/funcs/avmPredictPropertyValue.d.ts +1 -1
- package/dist/commonjs/funcs/avmPredictPropertyValue.d.ts.map +1 -1
- package/dist/commonjs/funcs/avmPredictPropertyValue.js +1 -1
- package/dist/commonjs/funcs/avmPredictPropertyValue.js.map +1 -1
- package/dist/commonjs/funcs/propertyGetProperties.js +1 -0
- package/dist/commonjs/funcs/propertyGetProperties.js.map +1 -1
- package/dist/commonjs/funcs/propertyGetPropertiesByLocation.js +1 -0
- package/dist/commonjs/funcs/propertyGetPropertiesByLocation.js.map +1 -1
- package/dist/commonjs/funcs/propertyGetPropertiesBySource.js +1 -0
- package/dist/commonjs/funcs/propertyGetPropertiesBySource.js.map +1 -1
- package/dist/commonjs/funcs/searchSearchRetrieve.d.ts +23 -0
- package/dist/commonjs/funcs/searchSearchRetrieve.d.ts.map +1 -0
- package/dist/commonjs/funcs/searchSearchRetrieve.js +128 -0
- package/dist/commonjs/funcs/searchSearchRetrieve.js.map +1 -0
- package/dist/commonjs/funcs/searchSearchSuggest.d.ts +3 -1
- package/dist/commonjs/funcs/searchSearchSuggest.d.ts.map +1 -1
- package/dist/commonjs/funcs/searchSearchSuggest.js +5 -1
- package/dist/commonjs/funcs/searchSearchSuggest.js.map +1 -1
- package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts +1 -1
- package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts.map +1 -1
- package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js +2 -1
- package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/sdk/models/errors/index.d.ts +1 -0
- package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/errors/index.js +1 -0
- package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
- package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts +65 -0
- package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.js +55 -1
- package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.js.map +1 -1
- package/dist/commonjs/sdk/models/errors/predictpropertyvalue.d.ts +65 -0
- package/dist/commonjs/sdk/models/errors/predictpropertyvalue.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/errors/predictpropertyvalue.js +57 -1
- package/dist/commonjs/sdk/models/errors/predictpropertyvalue.js.map +1 -1
- package/dist/commonjs/sdk/models/errors/searchretrieve.d.ts +201 -0
- package/dist/commonjs/sdk/models/errors/searchretrieve.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/errors/searchretrieve.js +213 -0
- package/dist/commonjs/sdk/models/errors/searchretrieve.js.map +1 -0
- package/dist/commonjs/sdk/models/operations/getcensuswholelevel.d.ts +1 -0
- package/dist/commonjs/sdk/models/operations/getcensuswholelevel.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getcensuswholelevel.js +1 -0
- package/dist/commonjs/sdk/models/operations/getcensuswholelevel.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts +18 -15
- package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getlistingbyid.js +15 -15
- package/dist/commonjs/sdk/models/operations/getlistingbyid.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getlistingbysource.d.ts +18 -15
- package/dist/commonjs/sdk/models/operations/getlistingbysource.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getlistingbysource.js +15 -15
- package/dist/commonjs/sdk/models/operations/getlistingbysource.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts +18 -15
- package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getlistingsbylocation.js +16 -15
- package/dist/commonjs/sdk/models/operations/getlistingsbylocation.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getproperties.d.ts +5 -0
- package/dist/commonjs/sdk/models/operations/getproperties.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getproperties.js +1 -0
- package/dist/commonjs/sdk/models/operations/getproperties.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.d.ts +5 -0
- package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.js +1 -0
- package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getpropertiesbysource.d.ts +5 -0
- package/dist/commonjs/sdk/models/operations/getpropertiesbysource.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getpropertiesbysource.js +1 -0
- package/dist/commonjs/sdk/models/operations/getpropertiesbysource.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/index.d.ts +1 -0
- package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/index.js +1 -0
- package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/querylistings.d.ts +18 -15
- package/dist/commonjs/sdk/models/operations/querylistings.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/querylistings.js +17 -16
- package/dist/commonjs/sdk/models/operations/querylistings.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts +18 -15
- package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/querylistingsbysource.js +16 -15
- package/dist/commonjs/sdk/models/operations/querylistingsbysource.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts +16 -3
- package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/resolveaddress.js +18 -3
- package/dist/commonjs/sdk/models/operations/resolveaddress.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/searchretrieve.d.ts +20 -0
- package/dist/commonjs/sdk/models/operations/searchretrieve.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/operations/searchretrieve.js +55 -0
- package/dist/commonjs/sdk/models/operations/searchretrieve.js.map +1 -0
- package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts +35 -0
- package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/searchsuggest.js +18 -1
- package/dist/commonjs/sdk/models/operations/searchsuggest.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts +27 -0
- package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/addressresolverequest.js +25 -1
- package/dist/commonjs/sdk/models/shared/addressresolverequest.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/advancedlisting.d.ts +2 -2
- package/dist/commonjs/sdk/models/shared/advancedlisting.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/advancedlisting.js +2 -2
- package/dist/commonjs/sdk/models/shared/advancedlisting.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/aggregationresult.d.ts +2 -1
- package/dist/commonjs/sdk/models/shared/aggregationresult.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/aggregationresult.js +2 -0
- package/dist/commonjs/sdk/models/shared/aggregationresult.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.d.ts +20 -0
- package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.js +13 -1
- package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/censusrolluprequest.d.ts +20 -0
- package/dist/commonjs/sdk/models/shared/censusrolluprequest.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/censusrolluprequest.js +12 -1
- package/dist/commonjs/sdk/models/shared/censusrolluprequest.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/geocodeprecision.d.ts +17 -0
- package/dist/commonjs/sdk/models/shared/geocodeprecision.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/geocodeprecision.js +51 -0
- package/dist/commonjs/sdk/models/shared/geocodeprecision.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/histogrambucket.d.ts +7 -0
- package/dist/commonjs/sdk/models/shared/histogrambucket.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/histogrambucket.js +4 -2
- package/dist/commonjs/sdk/models/shared/histogrambucket.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/index.d.ts +15 -7
- package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/index.js +15 -7
- package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/mortgagecharge.d.ts +38 -0
- package/dist/commonjs/sdk/models/shared/mortgagecharge.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/{extractionmortgagecharge.js → mortgagecharge.js} +11 -11
- package/dist/commonjs/sdk/models/shared/mortgagecharge.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/nestedaggregationresult.d.ts +16 -0
- package/dist/commonjs/sdk/models/shared/nestedaggregationresult.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/{extractionproprietor.js → nestedaggregationresult.js} +12 -15
- package/dist/commonjs/sdk/models/shared/nestedaggregationresult.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/othercharge.d.ts +23 -0
- package/dist/commonjs/sdk/models/shared/othercharge.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/{extractionothercharge.js → othercharge.js} +6 -6
- package/dist/commonjs/sdk/models/shared/othercharge.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts +24 -2
- package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/propertyaddress.js +14 -2
- package/dist/commonjs/sdk/models/shared/propertyaddress.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.d.ts +5 -0
- package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.js +1 -0
- package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts +38 -0
- package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/propertydataapi.js +22 -1
- package/dist/commonjs/sdk/models/shared/propertydataapi.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts +5 -0
- package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js +1 -0
- package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/registeredcharges.d.ts +14 -0
- package/dist/commonjs/sdk/models/shared/registeredcharges.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/registeredcharges.js +54 -0
- package/dist/commonjs/sdk/models/shared/registeredcharges.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/salerecord.d.ts +45 -0
- package/dist/commonjs/sdk/models/shared/salerecord.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/salerecord.js +26 -1
- package/dist/commonjs/sdk/models/shared/salerecord.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/searchresponse.d.ts +8 -0
- package/dist/commonjs/sdk/models/shared/searchresponse.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/searchresponse.js +4 -0
- package/dist/commonjs/sdk/models/shared/searchresponse.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/searchretrieveresponse.d.ts +82 -0
- package/dist/commonjs/sdk/models/shared/searchretrieveresponse.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/searchretrieveresponse.js +88 -0
- package/dist/commonjs/sdk/models/shared/searchretrieveresponse.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/streetmatch.d.ts +106 -0
- package/dist/commonjs/sdk/models/shared/streetmatch.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/streetmatch.js +84 -0
- package/dist/commonjs/sdk/models/shared/streetmatch.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/termsbucket.d.ts +3 -0
- package/dist/commonjs/sdk/models/shared/termsbucket.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/termsbucket.js +2 -2
- package/dist/commonjs/sdk/models/shared/termsbucket.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/titlecovenant.d.ts +23 -0
- package/dist/commonjs/sdk/models/shared/titlecovenant.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/{extractionrestriction.js → titlecovenant.js} +6 -6
- package/dist/commonjs/sdk/models/shared/titlecovenant.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/{extractiondocumentsummary.d.ts → titledocumentsummary.d.ts} +9 -9
- package/dist/commonjs/sdk/models/shared/titledocumentsummary.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/{extractiondocumentsummary.js → titledocumentsummary.js} +11 -11
- package/dist/commonjs/sdk/models/shared/titledocumentsummary.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts +83 -0
- package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/titleextractionpayload.js +103 -0
- package/dist/commonjs/sdk/models/shared/titleextractionpayload.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.d.ts +2 -2
- package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.js +2 -2
- package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.js.map +1 -1
- package/dist/{esm/sdk/models/shared/extractionnotice.d.ts → commonjs/sdk/models/shared/titlenotice.d.ts} +13 -4
- package/dist/commonjs/sdk/models/shared/titlenotice.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/{extractionnotice.js → titlenotice.js} +6 -6
- package/dist/commonjs/sdk/models/shared/titlenotice.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/titleproprietor.d.ts +54 -0
- package/dist/commonjs/sdk/models/shared/titleproprietor.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/titleproprietor.js +75 -0
- package/dist/commonjs/sdk/models/shared/titleproprietor.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts +23 -0
- package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/titlerestriction.js +54 -0
- package/dist/commonjs/sdk/models/shared/titlerestriction.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.d.ts +13 -0
- package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.js +50 -0
- package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts +15 -0
- package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/titlesummarycounts.js +55 -0
- package/dist/commonjs/sdk/models/shared/titlesummarycounts.js.map +1 -0
- package/dist/commonjs/sdk/search.d.ts +14 -1
- package/dist/commonjs/sdk/search.d.ts.map +1 -1
- package/dist/commonjs/sdk/search.js +17 -1
- package/dist/commonjs/sdk/search.js.map +1 -1
- package/dist/esm/address-search/__tests__/controller.test.d.ts +2 -0
- package/dist/esm/address-search/__tests__/controller.test.d.ts.map +1 -0
- package/dist/esm/address-search/__tests__/controller.test.js +327 -0
- package/dist/esm/address-search/__tests__/controller.test.js.map +1 -0
- package/dist/esm/address-search/__tests__/default-transports.test.d.ts +2 -0
- package/dist/esm/address-search/__tests__/default-transports.test.d.ts.map +1 -0
- package/dist/esm/address-search/__tests__/default-transports.test.js +159 -0
- package/dist/esm/address-search/__tests__/default-transports.test.js.map +1 -0
- package/dist/esm/address-search/__tests__/narrow.test.d.ts +2 -0
- package/dist/esm/address-search/__tests__/narrow.test.d.ts.map +1 -0
- package/dist/esm/address-search/__tests__/narrow.test.js +61 -0
- package/dist/esm/address-search/__tests__/narrow.test.js.map +1 -0
- package/dist/esm/address-search/controller.d.ts +14 -0
- package/dist/esm/address-search/controller.d.ts.map +1 -0
- package/dist/esm/address-search/controller.js +187 -0
- package/dist/esm/address-search/controller.js.map +1 -0
- package/dist/esm/address-search/default-transports.d.ts +52 -0
- package/dist/esm/address-search/default-transports.d.ts.map +1 -0
- package/dist/esm/address-search/default-transports.js +129 -0
- package/dist/esm/address-search/default-transports.js.map +1 -0
- package/dist/esm/address-search/errors.d.ts +5 -0
- package/dist/esm/address-search/errors.d.ts.map +1 -0
- package/dist/esm/address-search/errors.js +8 -0
- package/dist/esm/address-search/errors.js.map +1 -0
- package/dist/esm/address-search/index.d.ts +8 -0
- package/dist/esm/address-search/index.d.ts.map +1 -0
- package/dist/esm/address-search/index.js +30 -0
- package/dist/esm/address-search/index.js.map +1 -0
- package/dist/esm/address-search/lru-cache.d.ts +13 -0
- package/dist/esm/address-search/lru-cache.d.ts.map +1 -0
- package/dist/esm/address-search/lru-cache.js +46 -0
- package/dist/esm/address-search/lru-cache.js.map +1 -0
- package/dist/esm/address-search/narrow.d.ts +21 -0
- package/dist/esm/address-search/narrow.d.ts.map +1 -0
- package/dist/esm/address-search/narrow.js +43 -0
- package/dist/esm/address-search/narrow.js.map +1 -0
- package/dist/esm/address-search/types.d.ts +125 -0
- package/dist/esm/address-search/types.d.ts.map +1 -0
- package/dist/esm/address-search/types.js +8 -0
- package/dist/esm/address-search/types.js.map +1 -0
- package/dist/esm/address-search.d.ts +3 -0
- package/dist/esm/address-search.d.ts.map +1 -0
- package/dist/esm/address-search.js +6 -0
- package/dist/esm/address-search.js.map +1 -0
- package/dist/esm/funcs/avmPredictPropertyValue.d.ts +1 -1
- package/dist/esm/funcs/avmPredictPropertyValue.d.ts.map +1 -1
- package/dist/esm/funcs/avmPredictPropertyValue.js +1 -1
- package/dist/esm/funcs/avmPredictPropertyValue.js.map +1 -1
- package/dist/esm/funcs/propertyGetProperties.js +1 -0
- package/dist/esm/funcs/propertyGetProperties.js.map +1 -1
- package/dist/esm/funcs/propertyGetPropertiesByLocation.js +1 -0
- package/dist/esm/funcs/propertyGetPropertiesByLocation.js.map +1 -1
- package/dist/esm/funcs/propertyGetPropertiesBySource.js +1 -0
- package/dist/esm/funcs/propertyGetPropertiesBySource.js.map +1 -1
- package/dist/esm/funcs/searchSearchRetrieve.d.ts +23 -0
- package/dist/esm/funcs/searchSearchRetrieve.d.ts.map +1 -0
- package/dist/esm/funcs/searchSearchRetrieve.js +92 -0
- package/dist/esm/funcs/searchSearchRetrieve.js.map +1 -0
- package/dist/esm/funcs/searchSearchSuggest.d.ts +3 -1
- package/dist/esm/funcs/searchSearchSuggest.d.ts.map +1 -1
- package/dist/esm/funcs/searchSearchSuggest.js +5 -1
- package/dist/esm/funcs/searchSearchSuggest.js.map +1 -1
- package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts +1 -1
- package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts.map +1 -1
- package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js +2 -1
- package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/sdk/models/errors/index.d.ts +1 -0
- package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/errors/index.js +1 -0
- package/dist/esm/sdk/models/errors/index.js.map +1 -1
- package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts +65 -0
- package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts.map +1 -1
- package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.js +52 -0
- package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.js.map +1 -1
- package/dist/esm/sdk/models/errors/predictpropertyvalue.d.ts +65 -0
- package/dist/esm/sdk/models/errors/predictpropertyvalue.d.ts.map +1 -1
- package/dist/esm/sdk/models/errors/predictpropertyvalue.js +54 -0
- package/dist/esm/sdk/models/errors/predictpropertyvalue.js.map +1 -1
- package/dist/esm/sdk/models/errors/searchretrieve.d.ts +201 -0
- package/dist/esm/sdk/models/errors/searchretrieve.d.ts.map +1 -0
- package/dist/esm/sdk/models/errors/searchretrieve.js +171 -0
- package/dist/esm/sdk/models/errors/searchretrieve.js.map +1 -0
- package/dist/esm/sdk/models/operations/getcensuswholelevel.d.ts +1 -0
- package/dist/esm/sdk/models/operations/getcensuswholelevel.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getcensuswholelevel.js +1 -0
- package/dist/esm/sdk/models/operations/getcensuswholelevel.js.map +1 -1
- package/dist/esm/sdk/models/operations/getlistingbyid.d.ts +18 -15
- package/dist/esm/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getlistingbyid.js +16 -16
- package/dist/esm/sdk/models/operations/getlistingbyid.js.map +1 -1
- package/dist/esm/sdk/models/operations/getlistingbysource.d.ts +18 -15
- package/dist/esm/sdk/models/operations/getlistingbysource.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getlistingbysource.js +16 -16
- package/dist/esm/sdk/models/operations/getlistingbysource.js.map +1 -1
- package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts +18 -15
- package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getlistingsbylocation.js +17 -16
- package/dist/esm/sdk/models/operations/getlistingsbylocation.js.map +1 -1
- package/dist/esm/sdk/models/operations/getproperties.d.ts +5 -0
- package/dist/esm/sdk/models/operations/getproperties.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getproperties.js +1 -0
- package/dist/esm/sdk/models/operations/getproperties.js.map +1 -1
- package/dist/esm/sdk/models/operations/getpropertiesbylocation.d.ts +5 -0
- package/dist/esm/sdk/models/operations/getpropertiesbylocation.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getpropertiesbylocation.js +1 -0
- package/dist/esm/sdk/models/operations/getpropertiesbylocation.js.map +1 -1
- package/dist/esm/sdk/models/operations/getpropertiesbysource.d.ts +5 -0
- package/dist/esm/sdk/models/operations/getpropertiesbysource.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getpropertiesbysource.js +1 -0
- package/dist/esm/sdk/models/operations/getpropertiesbysource.js.map +1 -1
- package/dist/esm/sdk/models/operations/index.d.ts +1 -0
- package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/index.js +1 -0
- package/dist/esm/sdk/models/operations/index.js.map +1 -1
- package/dist/esm/sdk/models/operations/querylistings.d.ts +18 -15
- package/dist/esm/sdk/models/operations/querylistings.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/querylistings.js +18 -17
- package/dist/esm/sdk/models/operations/querylistings.js.map +1 -1
- package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts +18 -15
- package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/querylistingsbysource.js +17 -16
- package/dist/esm/sdk/models/operations/querylistingsbysource.js.map +1 -1
- package/dist/esm/sdk/models/operations/resolveaddress.d.ts +16 -3
- package/dist/esm/sdk/models/operations/resolveaddress.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/resolveaddress.js +16 -2
- package/dist/esm/sdk/models/operations/resolveaddress.js.map +1 -1
- package/dist/esm/sdk/models/operations/searchretrieve.d.ts +20 -0
- package/dist/esm/sdk/models/operations/searchretrieve.d.ts.map +1 -0
- package/dist/esm/sdk/models/operations/searchretrieve.js +18 -0
- package/dist/esm/sdk/models/operations/searchretrieve.js.map +1 -0
- package/dist/esm/sdk/models/operations/searchsuggest.d.ts +35 -0
- package/dist/esm/sdk/models/operations/searchsuggest.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/searchsuggest.js +17 -0
- package/dist/esm/sdk/models/operations/searchsuggest.js.map +1 -1
- package/dist/esm/sdk/models/shared/addressresolverequest.d.ts +27 -0
- package/dist/esm/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/addressresolverequest.js +23 -0
- package/dist/esm/sdk/models/shared/addressresolverequest.js.map +1 -1
- package/dist/esm/sdk/models/shared/advancedlisting.d.ts +2 -2
- package/dist/esm/sdk/models/shared/advancedlisting.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/advancedlisting.js +2 -2
- package/dist/esm/sdk/models/shared/advancedlisting.js.map +1 -1
- package/dist/esm/sdk/models/shared/aggregationresult.d.ts +2 -1
- package/dist/esm/sdk/models/shared/aggregationresult.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/aggregationresult.js +2 -0
- package/dist/esm/sdk/models/shared/aggregationresult.js.map +1 -1
- package/dist/esm/sdk/models/shared/censusareaprofilerequest.d.ts +20 -0
- package/dist/esm/sdk/models/shared/censusareaprofilerequest.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/censusareaprofilerequest.js +12 -0
- package/dist/esm/sdk/models/shared/censusareaprofilerequest.js.map +1 -1
- package/dist/esm/sdk/models/shared/censusrolluprequest.d.ts +20 -0
- package/dist/esm/sdk/models/shared/censusrolluprequest.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/censusrolluprequest.js +11 -0
- package/dist/esm/sdk/models/shared/censusrolluprequest.js.map +1 -1
- package/dist/esm/sdk/models/shared/geocodeprecision.d.ts +17 -0
- package/dist/esm/sdk/models/shared/geocodeprecision.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/geocodeprecision.js +15 -0
- package/dist/esm/sdk/models/shared/geocodeprecision.js.map +1 -0
- package/dist/esm/sdk/models/shared/histogrambucket.d.ts +7 -0
- package/dist/esm/sdk/models/shared/histogrambucket.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/histogrambucket.js +5 -3
- package/dist/esm/sdk/models/shared/histogrambucket.js.map +1 -1
- package/dist/esm/sdk/models/shared/index.d.ts +15 -7
- package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/index.js +15 -7
- package/dist/esm/sdk/models/shared/index.js.map +1 -1
- package/dist/esm/sdk/models/shared/mortgagecharge.d.ts +38 -0
- package/dist/esm/sdk/models/shared/mortgagecharge.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/mortgagecharge.js +28 -0
- package/dist/esm/sdk/models/shared/mortgagecharge.js.map +1 -0
- package/dist/esm/sdk/models/shared/nestedaggregationresult.d.ts +16 -0
- package/dist/esm/sdk/models/shared/nestedaggregationresult.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/nestedaggregationresult.js +18 -0
- package/dist/esm/sdk/models/shared/nestedaggregationresult.js.map +1 -0
- package/dist/esm/sdk/models/shared/othercharge.d.ts +23 -0
- package/dist/esm/sdk/models/shared/othercharge.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/{extractionothercharge.js → othercharge.js} +4 -4
- package/dist/esm/sdk/models/shared/othercharge.js.map +1 -0
- package/dist/esm/sdk/models/shared/propertyaddress.d.ts +24 -2
- package/dist/esm/sdk/models/shared/propertyaddress.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/propertyaddress.js +13 -1
- package/dist/esm/sdk/models/shared/propertyaddress.js.map +1 -1
- package/dist/esm/sdk/models/shared/propertybyslugsrequest.d.ts +5 -0
- package/dist/esm/sdk/models/shared/propertybyslugsrequest.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/propertybyslugsrequest.js +1 -0
- package/dist/esm/sdk/models/shared/propertybyslugsrequest.js.map +1 -1
- package/dist/esm/sdk/models/shared/propertydataapi.d.ts +38 -0
- package/dist/esm/sdk/models/shared/propertydataapi.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/propertydataapi.js +21 -0
- package/dist/esm/sdk/models/shared/propertydataapi.js.map +1 -1
- package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts +5 -0
- package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/propertyqueryrequest.js +1 -0
- package/dist/esm/sdk/models/shared/propertyqueryrequest.js.map +1 -1
- package/dist/esm/sdk/models/shared/registeredcharges.d.ts +14 -0
- package/dist/esm/sdk/models/shared/registeredcharges.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/registeredcharges.js +17 -0
- package/dist/esm/sdk/models/shared/registeredcharges.js.map +1 -0
- package/dist/esm/sdk/models/shared/salerecord.d.ts +45 -0
- package/dist/esm/sdk/models/shared/salerecord.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/salerecord.js +25 -0
- package/dist/esm/sdk/models/shared/salerecord.js.map +1 -1
- package/dist/esm/sdk/models/shared/searchresponse.d.ts +8 -0
- package/dist/esm/sdk/models/shared/searchresponse.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/searchresponse.js +4 -0
- package/dist/esm/sdk/models/shared/searchresponse.js.map +1 -1
- package/dist/esm/sdk/models/shared/searchretrieveresponse.d.ts +82 -0
- package/dist/esm/sdk/models/shared/searchretrieveresponse.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/searchretrieveresponse.js +50 -0
- package/dist/esm/sdk/models/shared/searchretrieveresponse.js.map +1 -0
- package/dist/esm/sdk/models/shared/streetmatch.d.ts +106 -0
- package/dist/esm/sdk/models/shared/streetmatch.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/streetmatch.js +45 -0
- package/dist/esm/sdk/models/shared/streetmatch.js.map +1 -0
- package/dist/esm/sdk/models/shared/termsbucket.d.ts +3 -0
- package/dist/esm/sdk/models/shared/termsbucket.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/termsbucket.js +3 -3
- package/dist/esm/sdk/models/shared/termsbucket.js.map +1 -1
- package/dist/esm/sdk/models/shared/titlecovenant.d.ts +23 -0
- package/dist/esm/sdk/models/shared/titlecovenant.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/{extractionrestriction.js → titlecovenant.js} +4 -4
- package/dist/esm/sdk/models/shared/titlecovenant.js.map +1 -0
- package/dist/esm/sdk/models/shared/{extractiondocumentsummary.d.ts → titledocumentsummary.d.ts} +9 -9
- package/dist/esm/sdk/models/shared/titledocumentsummary.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/{extractiondocumentsummary.js → titledocumentsummary.js} +9 -9
- package/dist/esm/sdk/models/shared/titledocumentsummary.js.map +1 -0
- package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts +83 -0
- package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/titleextractionpayload.js +65 -0
- package/dist/esm/sdk/models/shared/titleextractionpayload.js.map +1 -0
- package/dist/esm/sdk/models/shared/titleextractionpollresponse.d.ts +2 -2
- package/dist/esm/sdk/models/shared/titleextractionpollresponse.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/titleextractionpollresponse.js +2 -2
- package/dist/esm/sdk/models/shared/titleextractionpollresponse.js.map +1 -1
- package/dist/{commonjs/sdk/models/shared/extractionnotice.d.ts → esm/sdk/models/shared/titlenotice.d.ts} +13 -4
- package/dist/esm/sdk/models/shared/titlenotice.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/{extractionnotice.js → titlenotice.js} +4 -4
- package/dist/esm/sdk/models/shared/titlenotice.js.map +1 -0
- package/dist/esm/sdk/models/shared/titleproprietor.d.ts +54 -0
- package/dist/esm/sdk/models/shared/titleproprietor.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/titleproprietor.js +38 -0
- package/dist/esm/sdk/models/shared/titleproprietor.js.map +1 -0
- package/dist/esm/sdk/models/shared/titlerestriction.d.ts +23 -0
- package/dist/esm/sdk/models/shared/titlerestriction.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/titlerestriction.js +17 -0
- package/dist/esm/sdk/models/shared/titlerestriction.js.map +1 -0
- package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.d.ts +13 -0
- package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.js +13 -0
- package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.js.map +1 -0
- package/dist/esm/sdk/models/shared/titlesummarycounts.d.ts +15 -0
- package/dist/esm/sdk/models/shared/titlesummarycounts.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/titlesummarycounts.js +18 -0
- package/dist/esm/sdk/models/shared/titlesummarycounts.js.map +1 -0
- package/dist/esm/sdk/search.d.ts +14 -1
- package/dist/esm/sdk/search.d.ts.map +1 -1
- package/dist/esm/sdk/search.js +17 -1
- package/dist/esm/sdk/search.js.map +1 -1
- package/package.json +3 -2
- package/src/address-search/__tests__/controller.test.ts +395 -0
- package/src/address-search/__tests__/default-transports.test.ts +201 -0
- package/src/address-search/__tests__/narrow.test.ts +74 -0
- package/src/address-search/controller.ts +219 -0
- package/src/address-search/default-transports.ts +199 -0
- package/src/address-search/errors.ts +7 -0
- package/src/address-search/index.ts +54 -0
- package/src/address-search/lru-cache.ts +34 -0
- package/src/address-search/narrow.ts +45 -0
- package/src/address-search/types.ts +147 -0
- package/src/address-search.ts +40 -0
- package/src/funcs/avmPredictPropertyValue.ts +9 -2
- package/src/funcs/propertyGetProperties.ts +1 -0
- package/src/funcs/propertyGetPropertiesByLocation.ts +1 -0
- package/src/funcs/propertyGetPropertiesBySource.ts +1 -0
- package/src/funcs/searchSearchRetrieve.ts +192 -0
- package/src/funcs/searchSearchSuggest.ts +5 -1
- package/src/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.ts +8 -0
- package/src/lib/config.ts +3 -3
- package/src/sdk/models/errors/index.ts +1 -0
- package/src/sdk/models/errors/postv1titledeedstitlenumberpurchase.ts +144 -0
- package/src/sdk/models/errors/predictpropertyvalue.ts +136 -0
- package/src/sdk/models/errors/searchretrieve.ts +391 -0
- package/src/sdk/models/operations/getcensuswholelevel.ts +1 -0
- package/src/sdk/models/operations/getlistingbyid.ts +84 -76
- package/src/sdk/models/operations/getlistingbysource.ts +95 -87
- package/src/sdk/models/operations/getlistingsbylocation.ts +95 -86
- package/src/sdk/models/operations/getproperties.ts +6 -0
- package/src/sdk/models/operations/getpropertiesbylocation.ts +6 -0
- package/src/sdk/models/operations/getpropertiesbysource.ts +6 -0
- package/src/sdk/models/operations/index.ts +1 -0
- package/src/sdk/models/operations/querylistings.ts +91 -82
- package/src/sdk/models/operations/querylistingsbysource.ts +95 -86
- package/src/sdk/models/operations/resolveaddress.ts +50 -12
- package/src/sdk/models/operations/searchretrieve.ts +45 -0
- package/src/sdk/models/operations/searchsuggest.ts +41 -0
- package/src/sdk/models/shared/addressresolverequest.ts +60 -0
- package/src/sdk/models/shared/advancedlisting.ts +4 -4
- package/src/sdk/models/shared/aggregationresult.ts +7 -1
- package/src/sdk/models/shared/censusareaprofilerequest.ts +24 -0
- package/src/sdk/models/shared/censusrolluprequest.ts +27 -0
- package/src/sdk/models/shared/geocodeprecision.ts +27 -0
- package/src/sdk/models/shared/histogrambucket.ts +19 -5
- package/src/sdk/models/shared/index.ts +15 -7
- package/src/sdk/models/shared/mortgagecharge.ts +76 -0
- package/src/sdk/models/shared/nestedaggregationresult.ts +47 -0
- package/src/sdk/models/shared/{extractionothercharge.ts → othercharge.ts} +16 -7
- package/src/sdk/models/shared/propertyaddress.ts +36 -3
- package/src/sdk/models/shared/propertybyslugsrequest.ts +6 -0
- package/src/sdk/models/shared/propertydataapi.ts +55 -0
- package/src/sdk/models/shared/propertyqueryrequest.ts +6 -0
- package/src/sdk/models/shared/registeredcharges.ts +40 -0
- package/src/sdk/models/shared/salerecord.ts +62 -0
- package/src/sdk/models/shared/searchresponse.ts +12 -0
- package/src/sdk/models/shared/searchretrieveresponse.ts +153 -0
- package/src/sdk/models/shared/streetmatch.ts +181 -0
- package/src/sdk/models/shared/termsbucket.ts +13 -5
- package/src/sdk/models/shared/{extractionrestriction.ts → titlecovenant.ts} +16 -7
- package/src/sdk/models/shared/{extractiondocumentsummary.ts → titledocumentsummary.ts} +20 -18
- package/src/sdk/models/shared/titleextractionpayload.ts +170 -0
- package/src/sdk/models/shared/titleextractionpollresponse.ts +5 -5
- package/src/sdk/models/shared/{extractionnotice.ts → titlenotice.ts} +16 -7
- package/src/sdk/models/shared/titleproprietor.ts +90 -0
- package/src/sdk/models/shared/titlerestriction.ts +48 -0
- package/src/sdk/models/shared/titleschedulenoticeoflease.ts +34 -0
- package/src/sdk/models/shared/titlesummarycounts.ts +41 -0
- package/src/sdk/search.ts +25 -1
- package/dist/commonjs/sdk/models/shared/extractiondocumentsummary.d.ts.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractiondocumentsummary.js.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.d.ts +0 -26
- package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.d.ts.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.js.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionnotice.d.ts.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionnotice.js.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionothercharge.d.ts +0 -14
- package/dist/commonjs/sdk/models/shared/extractionothercharge.d.ts.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionothercharge.js.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionpayload.d.ts +0 -63
- package/dist/commonjs/sdk/models/shared/extractionpayload.d.ts.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionpayload.js +0 -108
- package/dist/commonjs/sdk/models/shared/extractionpayload.js.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionproprietor.d.ts +0 -18
- package/dist/commonjs/sdk/models/shared/extractionproprietor.d.ts.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionproprietor.js.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionrestriction.d.ts +0 -14
- package/dist/commonjs/sdk/models/shared/extractionrestriction.d.ts.map +0 -1
- package/dist/commonjs/sdk/models/shared/extractionrestriction.js.map +0 -1
- package/dist/esm/sdk/models/shared/extractiondocumentsummary.d.ts.map +0 -1
- package/dist/esm/sdk/models/shared/extractiondocumentsummary.js.map +0 -1
- package/dist/esm/sdk/models/shared/extractionmortgagecharge.d.ts +0 -26
- package/dist/esm/sdk/models/shared/extractionmortgagecharge.d.ts.map +0 -1
- package/dist/esm/sdk/models/shared/extractionmortgagecharge.js +0 -28
- package/dist/esm/sdk/models/shared/extractionmortgagecharge.js.map +0 -1
- package/dist/esm/sdk/models/shared/extractionnotice.d.ts.map +0 -1
- package/dist/esm/sdk/models/shared/extractionnotice.js.map +0 -1
- package/dist/esm/sdk/models/shared/extractionothercharge.d.ts +0 -14
- package/dist/esm/sdk/models/shared/extractionothercharge.d.ts.map +0 -1
- package/dist/esm/sdk/models/shared/extractionothercharge.js.map +0 -1
- package/dist/esm/sdk/models/shared/extractionpayload.d.ts +0 -63
- package/dist/esm/sdk/models/shared/extractionpayload.d.ts.map +0 -1
- package/dist/esm/sdk/models/shared/extractionpayload.js +0 -68
- package/dist/esm/sdk/models/shared/extractionpayload.js.map +0 -1
- package/dist/esm/sdk/models/shared/extractionproprietor.d.ts +0 -18
- package/dist/esm/sdk/models/shared/extractionproprietor.d.ts.map +0 -1
- package/dist/esm/sdk/models/shared/extractionproprietor.js +0 -21
- package/dist/esm/sdk/models/shared/extractionproprietor.js.map +0 -1
- package/dist/esm/sdk/models/shared/extractionrestriction.d.ts +0 -14
- package/dist/esm/sdk/models/shared/extractionrestriction.d.ts.map +0 -1
- package/dist/esm/sdk/models/shared/extractionrestriction.js.map +0 -1
- package/src/sdk/models/shared/extractionmortgagecharge.ts +0 -66
- package/src/sdk/models/shared/extractionpayload.ts +0 -177
- package/src/sdk/models/shared/extractionproprietor.ts +0 -47
|
@@ -8,6 +8,7 @@ import * as openEnums from "../../types/enums.js";
|
|
|
8
8
|
import { ClosedEnum, OpenEnum } from "../../types/enums.js";
|
|
9
9
|
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
10
10
|
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
11
|
+
import * as shared from "../shared/index.js";
|
|
11
12
|
|
|
12
13
|
/**
|
|
13
14
|
* Object type identifier
|
|
@@ -148,7 +149,7 @@ export const ResolveAddressSource = {
|
|
|
148
149
|
*/
|
|
149
150
|
export type ResolveAddressSource = OpenEnum<typeof ResolveAddressSource>;
|
|
150
151
|
|
|
151
|
-
export type
|
|
152
|
+
export type ResolveAddress1 = {
|
|
152
153
|
/**
|
|
153
154
|
* Formatted address string
|
|
154
155
|
*/
|
|
@@ -157,6 +158,10 @@ export type Matches = {
|
|
|
157
158
|
* Match confidence score (0-100)
|
|
158
159
|
*/
|
|
159
160
|
confidence: number;
|
|
161
|
+
/**
|
|
162
|
+
* Result granularity discriminator
|
|
163
|
+
*/
|
|
164
|
+
granularity: "address";
|
|
160
165
|
/**
|
|
161
166
|
* Structural address component scores (0-1 each). Based on the ONS Address Index Matching Service (AIMS) methodology. Use these to understand which parts of the address matched well and which were uncertain.
|
|
162
167
|
*/
|
|
@@ -165,6 +170,10 @@ export type Matches = {
|
|
|
165
170
|
* Original parsed address fragment
|
|
166
171
|
*/
|
|
167
172
|
originalAddress: string;
|
|
173
|
+
/**
|
|
174
|
+
* How the returned point was derived (e.g. 'rooftop')
|
|
175
|
+
*/
|
|
176
|
+
precision?: shared.GeocodePrecision | undefined;
|
|
168
177
|
/**
|
|
169
178
|
* Match strategy that produced this result. direct-match: address tokens matched a single record with high precision. exact-match: full address string matched verbatim. partial-match: most address components matched; some inferred. fuzzy-match: approximate match allowing for typos or abbreviations. index-lookup: resolved via indexed reference data. postcode-fallback: matched by postcode when street-level matching failed. spatial-narrative: resolved from a descriptive or rural address using spatial analysis.
|
|
170
179
|
*/
|
|
@@ -175,6 +184,8 @@ export type Matches = {
|
|
|
175
184
|
uprn: string;
|
|
176
185
|
};
|
|
177
186
|
|
|
187
|
+
export type Matches = ResolveAddress1 | shared.StreetMatch;
|
|
188
|
+
|
|
178
189
|
/**
|
|
179
190
|
* Detected address pattern type
|
|
180
191
|
*/
|
|
@@ -278,9 +289,9 @@ export type Result = {
|
|
|
278
289
|
*/
|
|
279
290
|
matchQuality?: MatchQuality | undefined;
|
|
280
291
|
/**
|
|
281
|
-
* Array of matched addresses
|
|
292
|
+
* Array of matched addresses and/or streets
|
|
282
293
|
*/
|
|
283
|
-
matches: Array<
|
|
294
|
+
matches: Array<ResolveAddress1 | shared.StreetMatch>;
|
|
284
295
|
/**
|
|
285
296
|
* Metadata about the matching process
|
|
286
297
|
*/
|
|
@@ -407,16 +418,38 @@ export const ResolveAddressSource$inboundSchema: z.ZodType<
|
|
|
407
418
|
unknown
|
|
408
419
|
> = openEnums.inboundSchema(ResolveAddressSource);
|
|
409
420
|
|
|
421
|
+
/** @internal */
|
|
422
|
+
export const ResolveAddress1$inboundSchema: z.ZodType<
|
|
423
|
+
ResolveAddress1,
|
|
424
|
+
z.ZodTypeDef,
|
|
425
|
+
unknown
|
|
426
|
+
> = z.object({
|
|
427
|
+
address: z.string(),
|
|
428
|
+
confidence: z.number(),
|
|
429
|
+
granularity: z.literal("address"),
|
|
430
|
+
hopperComponents: z.lazy(() => HopperComponents$inboundSchema).optional(),
|
|
431
|
+
originalAddress: z.string(),
|
|
432
|
+
precision: shared.GeocodePrecision$inboundSchema.optional(),
|
|
433
|
+
source: ResolveAddressSource$inboundSchema,
|
|
434
|
+
uprn: z.string(),
|
|
435
|
+
});
|
|
436
|
+
|
|
437
|
+
export function resolveAddress1FromJSON(
|
|
438
|
+
jsonString: string,
|
|
439
|
+
): SafeParseResult<ResolveAddress1, SDKValidationError> {
|
|
440
|
+
return safeParse(
|
|
441
|
+
jsonString,
|
|
442
|
+
(x) => ResolveAddress1$inboundSchema.parse(JSON.parse(x)),
|
|
443
|
+
`Failed to parse 'ResolveAddress1' from JSON`,
|
|
444
|
+
);
|
|
445
|
+
}
|
|
446
|
+
|
|
410
447
|
/** @internal */
|
|
411
448
|
export const Matches$inboundSchema: z.ZodType<Matches, z.ZodTypeDef, unknown> =
|
|
412
|
-
z.
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
originalAddress: z.string(),
|
|
417
|
-
source: ResolveAddressSource$inboundSchema,
|
|
418
|
-
uprn: z.string(),
|
|
419
|
-
});
|
|
449
|
+
z.union([
|
|
450
|
+
z.lazy(() => ResolveAddress1$inboundSchema),
|
|
451
|
+
shared.StreetMatch$inboundSchema,
|
|
452
|
+
]);
|
|
420
453
|
|
|
421
454
|
export function matchesFromJSON(
|
|
422
455
|
jsonString: string,
|
|
@@ -498,7 +531,12 @@ export const Result$inboundSchema: z.ZodType<Result, z.ZodTypeDef, unknown> = z
|
|
|
498
531
|
confidence: z.number(),
|
|
499
532
|
confidenceZone: ConfidenceZone$inboundSchema.optional(),
|
|
500
533
|
matchQuality: z.lazy(() => MatchQuality$inboundSchema).optional(),
|
|
501
|
-
matches: z.array(
|
|
534
|
+
matches: z.array(
|
|
535
|
+
z.union([
|
|
536
|
+
z.lazy(() => ResolveAddress1$inboundSchema),
|
|
537
|
+
shared.StreetMatch$inboundSchema,
|
|
538
|
+
]),
|
|
539
|
+
),
|
|
502
540
|
metadata: z.lazy(() => ResolveAddressMetadata$inboundSchema),
|
|
503
541
|
recommendationCode: RecommendationCode$inboundSchema.optional(),
|
|
504
542
|
unambiguityScore: z.number().optional(),
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { remap as remap$ } from "../../../lib/primitives.js";
|
|
7
|
+
|
|
8
|
+
export type SearchRetrieveRequest = {
|
|
9
|
+
/**
|
|
10
|
+
* The `search_id` returned by the suggest response this selection was made from. Supplying it completes that search session. Omitted or unknown, the retrieve still works as a direct resolve and is recorded as its own transaction.
|
|
11
|
+
*/
|
|
12
|
+
searchId?: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* Unique Property Reference Number of the address to retrieve — the `uprn` field of a suggest result. The full record for this UPRN is returned and charged.
|
|
15
|
+
*/
|
|
16
|
+
uprn: string;
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
/** @internal */
|
|
20
|
+
export type SearchRetrieveRequest$Outbound = {
|
|
21
|
+
search_id?: string | undefined;
|
|
22
|
+
uprn: string;
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
/** @internal */
|
|
26
|
+
export const SearchRetrieveRequest$outboundSchema: z.ZodType<
|
|
27
|
+
SearchRetrieveRequest$Outbound,
|
|
28
|
+
z.ZodTypeDef,
|
|
29
|
+
SearchRetrieveRequest
|
|
30
|
+
> = z.object({
|
|
31
|
+
searchId: z.string().optional(),
|
|
32
|
+
uprn: z.string(),
|
|
33
|
+
}).transform((v) => {
|
|
34
|
+
return remap$(v, {
|
|
35
|
+
searchId: "search_id",
|
|
36
|
+
});
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
export function searchRetrieveRequestToJSON(
|
|
40
|
+
searchRetrieveRequest: SearchRetrieveRequest,
|
|
41
|
+
): string {
|
|
42
|
+
return JSON.stringify(
|
|
43
|
+
SearchRetrieveRequest$outboundSchema.parse(searchRetrieveRequest),
|
|
44
|
+
);
|
|
45
|
+
}
|
|
@@ -53,6 +53,26 @@ export const GeoMode = {
|
|
|
53
53
|
*/
|
|
54
54
|
export type GeoMode = ClosedEnum<typeof GeoMode>;
|
|
55
55
|
|
|
56
|
+
/**
|
|
57
|
+
* Result granularity level:
|
|
58
|
+
*
|
|
59
|
+
* @remarks
|
|
60
|
+
* - `address` (default): premise-level autocomplete — behaviour is unchanged.
|
|
61
|
+
* - `street`: returns one result per named street (USRN-level) with a representative centre point, for partial locations such as 'West Street, Sheffield'. Streets that share a name are disambiguated by the town in the query and, when supplied, the `lat`/`lng`/`radius_meters`/`geo_mode` params.
|
|
62
|
+
*/
|
|
63
|
+
export const Granularity = {
|
|
64
|
+
Address: "address",
|
|
65
|
+
Street: "street",
|
|
66
|
+
} as const;
|
|
67
|
+
/**
|
|
68
|
+
* Result granularity level:
|
|
69
|
+
*
|
|
70
|
+
* @remarks
|
|
71
|
+
* - `address` (default): premise-level autocomplete — behaviour is unchanged.
|
|
72
|
+
* - `street`: returns one result per named street (USRN-level) with a representative centre point, for partial locations such as 'West Street, Sheffield'. Streets that share a name are disambiguated by the town in the query and, when supplied, the `lat`/`lng`/`radius_meters`/`geo_mode` params.
|
|
73
|
+
*/
|
|
74
|
+
export type Granularity = ClosedEnum<typeof Granularity>;
|
|
75
|
+
|
|
56
76
|
export type SearchSuggestRequest = {
|
|
57
77
|
/**
|
|
58
78
|
* Restrict address results to current, addressable properties only. When 'true', excludes historical and superseded address records (those without a current LPI), returning only addresses that resolve to a live property record. Defaults to 'false' (the full address universe, including historical entries). Applies to address-source results only.
|
|
@@ -71,6 +91,14 @@ export type SearchSuggestRequest = {
|
|
|
71
91
|
* Applies to address-source results.
|
|
72
92
|
*/
|
|
73
93
|
geoMode?: GeoMode | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* Result granularity level:
|
|
96
|
+
*
|
|
97
|
+
* @remarks
|
|
98
|
+
* - `address` (default): premise-level autocomplete — behaviour is unchanged.
|
|
99
|
+
* - `street`: returns one result per named street (USRN-level) with a representative centre point, for partial locations such as 'West Street, Sheffield'. Streets that share a name are disambiguated by the town in the query and, when supplied, the `lat`/`lng`/`radius_meters`/`geo_mode` params.
|
|
100
|
+
*/
|
|
101
|
+
granularity?: Granularity | undefined;
|
|
74
102
|
/**
|
|
75
103
|
* Latitude of a geographic centre point (WGS84 decimal degrees, -90 to 90). Must be supplied together with `lng`. Enables proximity-aware ranking of address results, most effective when combined with `source=address`.
|
|
76
104
|
*/
|
|
@@ -95,6 +123,10 @@ export type SearchSuggestRequest = {
|
|
|
95
123
|
* Radius in metres from (`lat`, `lng`). Required when `geo_mode=restrict` (results outside the radius are excluded). When `geo_mode=bias`, it tunes the strength of the soft preference: the distance at which a result's textual score is roughly halved, and defaults to 10000 when omitted.
|
|
96
124
|
*/
|
|
97
125
|
radiusMeters?: number | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* Candidate-set session id returned by a previous suggest response (`search_id`). When supplied and still valid, the new query narrows within the already-fetched candidate set server-side — no new data fetch. An unknown or expired id falls back to a normal search.
|
|
128
|
+
*/
|
|
129
|
+
searchId?: string | undefined;
|
|
98
130
|
/**
|
|
99
131
|
* Filter results to specific search source (address or location)
|
|
100
132
|
*/
|
|
@@ -115,17 +147,23 @@ export const Classification$outboundSchema: z.ZodNativeEnum<
|
|
|
115
147
|
export const GeoMode$outboundSchema: z.ZodNativeEnum<typeof GeoMode> = z
|
|
116
148
|
.nativeEnum(GeoMode);
|
|
117
149
|
|
|
150
|
+
/** @internal */
|
|
151
|
+
export const Granularity$outboundSchema: z.ZodNativeEnum<typeof Granularity> = z
|
|
152
|
+
.nativeEnum(Granularity);
|
|
153
|
+
|
|
118
154
|
/** @internal */
|
|
119
155
|
export type SearchSuggestRequest$Outbound = {
|
|
120
156
|
addressable_only?: string | undefined;
|
|
121
157
|
classification?: string | undefined;
|
|
122
158
|
geo_mode?: string | undefined;
|
|
159
|
+
granularity?: string | undefined;
|
|
123
160
|
lat?: number | undefined;
|
|
124
161
|
limit?: string | undefined;
|
|
125
162
|
lng?: number | undefined;
|
|
126
163
|
offset?: string | undefined;
|
|
127
164
|
q: string;
|
|
128
165
|
radius_meters?: number | undefined;
|
|
166
|
+
search_id?: string | undefined;
|
|
129
167
|
source?: string | undefined;
|
|
130
168
|
};
|
|
131
169
|
|
|
@@ -138,18 +176,21 @@ export const SearchSuggestRequest$outboundSchema: z.ZodType<
|
|
|
138
176
|
addressableOnly: AddressableOnly$outboundSchema.optional(),
|
|
139
177
|
classification: Classification$outboundSchema.optional(),
|
|
140
178
|
geoMode: GeoMode$outboundSchema.optional(),
|
|
179
|
+
granularity: Granularity$outboundSchema.optional(),
|
|
141
180
|
lat: z.number().optional(),
|
|
142
181
|
limit: z.string().optional(),
|
|
143
182
|
lng: z.number().optional(),
|
|
144
183
|
offset: z.string().optional(),
|
|
145
184
|
q: z.string(),
|
|
146
185
|
radiusMeters: z.number().int().optional(),
|
|
186
|
+
searchId: z.string().optional(),
|
|
147
187
|
source: z.string().optional(),
|
|
148
188
|
}).transform((v) => {
|
|
149
189
|
return remap$(v, {
|
|
150
190
|
addressableOnly: "addressable_only",
|
|
151
191
|
geoMode: "geo_mode",
|
|
152
192
|
radiusMeters: "radius_meters",
|
|
193
|
+
searchId: "search_id",
|
|
153
194
|
});
|
|
154
195
|
});
|
|
155
196
|
|
|
@@ -20,6 +20,24 @@ export type AddressResolveRequestClassification = ClosedEnum<
|
|
|
20
20
|
typeof AddressResolveRequestClassification
|
|
21
21
|
>;
|
|
22
22
|
|
|
23
|
+
export const AddressResolveRequest2 = {
|
|
24
|
+
Auto: "auto",
|
|
25
|
+
} as const;
|
|
26
|
+
export type AddressResolveRequest2 = ClosedEnum<typeof AddressResolveRequest2>;
|
|
27
|
+
|
|
28
|
+
export const AddressResolveRequest1 = {
|
|
29
|
+
Address: "address",
|
|
30
|
+
Street: "street",
|
|
31
|
+
} as const;
|
|
32
|
+
export type AddressResolveRequest1 = ClosedEnum<typeof AddressResolveRequest1>;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Resolution granularity. 'address' (default): premise-level UPRN resolution — behaviour is unchanged. 'street': resolve to a named street (USRN-level) with a representative point, for partial inputs such as 'West Street, Sheffield' that have no building number. 'auto': try premise-level first and fall back to street-level when no building matches.
|
|
36
|
+
*/
|
|
37
|
+
export type AddressResolveRequestGranularity =
|
|
38
|
+
| AddressResolveRequest1
|
|
39
|
+
| AddressResolveRequest2;
|
|
40
|
+
|
|
23
41
|
/**
|
|
24
42
|
* Optional matching configuration
|
|
25
43
|
*/
|
|
@@ -40,6 +58,10 @@ export type Options = {
|
|
|
40
58
|
* Confidence threshold below which fallback matching is triggered
|
|
41
59
|
*/
|
|
42
60
|
fallbackThreshold?: number | undefined;
|
|
61
|
+
/**
|
|
62
|
+
* Resolution granularity. 'address' (default): premise-level UPRN resolution — behaviour is unchanged. 'street': resolve to a named street (USRN-level) with a representative point, for partial inputs such as 'West Street, Sheffield' that have no building number. 'auto': try premise-level first and fall back to street-level when no building matches.
|
|
63
|
+
*/
|
|
64
|
+
granularity?: AddressResolveRequest1 | AddressResolveRequest2 | undefined;
|
|
43
65
|
/**
|
|
44
66
|
* Include detailed processing steps in response
|
|
45
67
|
*/
|
|
@@ -71,12 +93,46 @@ export const AddressResolveRequestClassification$outboundSchema:
|
|
|
71
93
|
AddressResolveRequestClassification,
|
|
72
94
|
);
|
|
73
95
|
|
|
96
|
+
/** @internal */
|
|
97
|
+
export const AddressResolveRequest2$outboundSchema: z.ZodNativeEnum<
|
|
98
|
+
typeof AddressResolveRequest2
|
|
99
|
+
> = z.nativeEnum(AddressResolveRequest2);
|
|
100
|
+
|
|
101
|
+
/** @internal */
|
|
102
|
+
export const AddressResolveRequest1$outboundSchema: z.ZodNativeEnum<
|
|
103
|
+
typeof AddressResolveRequest1
|
|
104
|
+
> = z.nativeEnum(AddressResolveRequest1);
|
|
105
|
+
|
|
106
|
+
/** @internal */
|
|
107
|
+
export type AddressResolveRequestGranularity$Outbound = string | string;
|
|
108
|
+
|
|
109
|
+
/** @internal */
|
|
110
|
+
export const AddressResolveRequestGranularity$outboundSchema: z.ZodType<
|
|
111
|
+
AddressResolveRequestGranularity$Outbound,
|
|
112
|
+
z.ZodTypeDef,
|
|
113
|
+
AddressResolveRequestGranularity
|
|
114
|
+
> = z.union([
|
|
115
|
+
AddressResolveRequest1$outboundSchema,
|
|
116
|
+
AddressResolveRequest2$outboundSchema,
|
|
117
|
+
]);
|
|
118
|
+
|
|
119
|
+
export function addressResolveRequestGranularityToJSON(
|
|
120
|
+
addressResolveRequestGranularity: AddressResolveRequestGranularity,
|
|
121
|
+
): string {
|
|
122
|
+
return JSON.stringify(
|
|
123
|
+
AddressResolveRequestGranularity$outboundSchema.parse(
|
|
124
|
+
addressResolveRequestGranularity,
|
|
125
|
+
),
|
|
126
|
+
);
|
|
127
|
+
}
|
|
128
|
+
|
|
74
129
|
/** @internal */
|
|
75
130
|
export type Options$Outbound = {
|
|
76
131
|
classification?: string | undefined;
|
|
77
132
|
confidenceThreshold?: number | undefined;
|
|
78
133
|
enableFallback?: boolean | undefined;
|
|
79
134
|
fallbackThreshold?: number | undefined;
|
|
135
|
+
granularity?: string | string | undefined;
|
|
80
136
|
includeProcessingDetails?: boolean | undefined;
|
|
81
137
|
maxResults?: number | undefined;
|
|
82
138
|
timeout?: number | undefined;
|
|
@@ -92,6 +148,10 @@ export const Options$outboundSchema: z.ZodType<
|
|
|
92
148
|
confidenceThreshold: z.number().optional(),
|
|
93
149
|
enableFallback: z.boolean().optional(),
|
|
94
150
|
fallbackThreshold: z.number().optional(),
|
|
151
|
+
granularity: z.union([
|
|
152
|
+
AddressResolveRequest1$outboundSchema,
|
|
153
|
+
AddressResolveRequest2$outboundSchema,
|
|
154
|
+
]).optional(),
|
|
95
155
|
includeProcessingDetails: z.boolean().optional(),
|
|
96
156
|
maxResults: z.number().optional(),
|
|
97
157
|
timeout: z.number().optional(),
|
|
@@ -82,7 +82,7 @@ export type FloorPlanImages = {
|
|
|
82
82
|
/**
|
|
83
83
|
* Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
|
|
84
84
|
*/
|
|
85
|
-
caption?: string | undefined;
|
|
85
|
+
caption?: string | null | undefined;
|
|
86
86
|
/**
|
|
87
87
|
* Zero-based display order for the image within its type group. The first image (order 0) is typically the hero/primary image used for thumbnails and search results.
|
|
88
88
|
*/
|
|
@@ -120,7 +120,7 @@ export type Images = {
|
|
|
120
120
|
/**
|
|
121
121
|
* Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
|
|
122
122
|
*/
|
|
123
|
-
caption?: string | undefined;
|
|
123
|
+
caption?: string | null | undefined;
|
|
124
124
|
/**
|
|
125
125
|
* Zero-based display order for the image within its type group. The first image (order 0) is typically the hero/primary image used for thumbnails and search results.
|
|
126
126
|
*/
|
|
@@ -319,7 +319,7 @@ export const FloorPlanImages$inboundSchema: z.ZodType<
|
|
|
319
319
|
z.ZodTypeDef,
|
|
320
320
|
unknown
|
|
321
321
|
> = z.object({
|
|
322
|
-
caption: z.string().optional(),
|
|
322
|
+
caption: z.nullable(z.string()).optional(),
|
|
323
323
|
order: z.number().optional(),
|
|
324
324
|
type: AdvancedListingSchemasType$inboundSchema.optional(),
|
|
325
325
|
url: z.string(),
|
|
@@ -345,7 +345,7 @@ export const AdvancedListingSchemasImagesType$inboundSchema: z.ZodType<
|
|
|
345
345
|
/** @internal */
|
|
346
346
|
export const Images$inboundSchema: z.ZodType<Images, z.ZodTypeDef, unknown> = z
|
|
347
347
|
.object({
|
|
348
|
-
caption: z.string().optional(),
|
|
348
|
+
caption: z.nullable(z.string()).optional(),
|
|
349
349
|
order: z.number().optional(),
|
|
350
350
|
type: AdvancedListingSchemasImagesType$inboundSchema.optional(),
|
|
351
351
|
url: z.string(),
|
|
@@ -14,6 +14,10 @@ import {
|
|
|
14
14
|
HistogramAggregationResult,
|
|
15
15
|
HistogramAggregationResult$inboundSchema,
|
|
16
16
|
} from "./histogramaggregationresult.js";
|
|
17
|
+
import {
|
|
18
|
+
NestedAggregationResult,
|
|
19
|
+
NestedAggregationResult$inboundSchema,
|
|
20
|
+
} from "./nestedaggregationresult.js";
|
|
17
21
|
import {
|
|
18
22
|
PercentilesAggregationResult,
|
|
19
23
|
PercentilesAggregationResult$inboundSchema,
|
|
@@ -37,7 +41,8 @@ export type AggregationResult =
|
|
|
37
41
|
| TermsAggregationResult
|
|
38
42
|
| HistogramAggregationResult
|
|
39
43
|
| PercentilesAggregationResult
|
|
40
|
-
| SingleValueAggregationResult
|
|
44
|
+
| SingleValueAggregationResult
|
|
45
|
+
| NestedAggregationResult;
|
|
41
46
|
|
|
42
47
|
/** @internal */
|
|
43
48
|
export const AggregationResult$inboundSchema: z.ZodType<
|
|
@@ -51,6 +56,7 @@ export const AggregationResult$inboundSchema: z.ZodType<
|
|
|
51
56
|
HistogramAggregationResult$inboundSchema,
|
|
52
57
|
PercentilesAggregationResult$inboundSchema,
|
|
53
58
|
SingleValueAggregationResult$inboundSchema,
|
|
59
|
+
NestedAggregationResult$inboundSchema,
|
|
54
60
|
]);
|
|
55
61
|
|
|
56
62
|
export function aggregationResultFromJSON(
|
|
@@ -3,11 +3,29 @@
|
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
5
|
import * as z from "zod/v3";
|
|
6
|
+
import { ClosedEnum } from "../../types/enums.js";
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
|
|
10
|
+
*/
|
|
11
|
+
export const CodeSystem = {
|
|
12
|
+
OnsGss: "ons_gss",
|
|
13
|
+
CsoSa: "cso_sa",
|
|
14
|
+
CsoEd: "cso_ed",
|
|
15
|
+
} as const;
|
|
16
|
+
/**
|
|
17
|
+
* Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
|
|
18
|
+
*/
|
|
19
|
+
export type CodeSystem = ClosedEnum<typeof CodeSystem>;
|
|
6
20
|
|
|
7
21
|
/**
|
|
8
22
|
* Request body for the multi-area census profile.
|
|
9
23
|
*/
|
|
10
24
|
export type CensusAreaProfileRequest = {
|
|
25
|
+
/**
|
|
26
|
+
* Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
|
|
27
|
+
*/
|
|
28
|
+
codeSystem?: CodeSystem | undefined;
|
|
11
29
|
/**
|
|
12
30
|
* Stable public dataset id.
|
|
13
31
|
*/
|
|
@@ -22,8 +40,13 @@ export type CensusAreaProfileRequest = {
|
|
|
22
40
|
variableSlugs?: Array<string> | undefined;
|
|
23
41
|
};
|
|
24
42
|
|
|
43
|
+
/** @internal */
|
|
44
|
+
export const CodeSystem$outboundSchema: z.ZodNativeEnum<typeof CodeSystem> = z
|
|
45
|
+
.nativeEnum(CodeSystem);
|
|
46
|
+
|
|
25
47
|
/** @internal */
|
|
26
48
|
export type CensusAreaProfileRequest$Outbound = {
|
|
49
|
+
codeSystem: string;
|
|
27
50
|
datasetCode: string;
|
|
28
51
|
geographyCodes: Array<string>;
|
|
29
52
|
variableSlugs?: Array<string> | undefined;
|
|
@@ -35,6 +58,7 @@ export const CensusAreaProfileRequest$outboundSchema: z.ZodType<
|
|
|
35
58
|
z.ZodTypeDef,
|
|
36
59
|
CensusAreaProfileRequest
|
|
37
60
|
> = z.object({
|
|
61
|
+
codeSystem: CodeSystem$outboundSchema.default("ons_gss"),
|
|
38
62
|
datasetCode: z.string(),
|
|
39
63
|
geographyCodes: z.array(z.string()),
|
|
40
64
|
variableSlugs: z.array(z.string()).optional(),
|
|
@@ -3,6 +3,22 @@
|
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
5
|
import * as z from "zod/v3";
|
|
6
|
+
import { ClosedEnum } from "../../types/enums.js";
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
|
|
10
|
+
*/
|
|
11
|
+
export const CensusRollupRequestCodeSystem = {
|
|
12
|
+
OnsGss: "ons_gss",
|
|
13
|
+
CsoSa: "cso_sa",
|
|
14
|
+
CsoEd: "cso_ed",
|
|
15
|
+
} as const;
|
|
16
|
+
/**
|
|
17
|
+
* Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
|
|
18
|
+
*/
|
|
19
|
+
export type CensusRollupRequestCodeSystem = ClosedEnum<
|
|
20
|
+
typeof CensusRollupRequestCodeSystem
|
|
21
|
+
>;
|
|
6
22
|
|
|
7
23
|
/**
|
|
8
24
|
* Request body for the custom-area census rollup. Ratios are SUM(count)/SUM(base), never an average of ratios.
|
|
@@ -12,6 +28,10 @@ export type CensusRollupRequest = {
|
|
|
12
28
|
* Category codes ('{classificationCode}-{NNN}') to roll up across the custom area. At least one is required; there is no wildcard — list every code you want.
|
|
13
29
|
*/
|
|
14
30
|
categoryCodes: Array<string>;
|
|
31
|
+
/**
|
|
32
|
+
* Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
|
|
33
|
+
*/
|
|
34
|
+
codeSystem?: CensusRollupRequestCodeSystem | undefined;
|
|
15
35
|
/**
|
|
16
36
|
* Stable public dataset id.
|
|
17
37
|
*/
|
|
@@ -22,9 +42,15 @@ export type CensusRollupRequest = {
|
|
|
22
42
|
geographyCodes: Array<string>;
|
|
23
43
|
};
|
|
24
44
|
|
|
45
|
+
/** @internal */
|
|
46
|
+
export const CensusRollupRequestCodeSystem$outboundSchema: z.ZodNativeEnum<
|
|
47
|
+
typeof CensusRollupRequestCodeSystem
|
|
48
|
+
> = z.nativeEnum(CensusRollupRequestCodeSystem);
|
|
49
|
+
|
|
25
50
|
/** @internal */
|
|
26
51
|
export type CensusRollupRequest$Outbound = {
|
|
27
52
|
categoryCodes: Array<string>;
|
|
53
|
+
codeSystem: string;
|
|
28
54
|
datasetCode: string;
|
|
29
55
|
geographyCodes: Array<string>;
|
|
30
56
|
};
|
|
@@ -36,6 +62,7 @@ export const CensusRollupRequest$outboundSchema: z.ZodType<
|
|
|
36
62
|
CensusRollupRequest
|
|
37
63
|
> = z.object({
|
|
38
64
|
categoryCodes: z.array(z.string()),
|
|
65
|
+
codeSystem: CensusRollupRequestCodeSystem$outboundSchema.default("ons_gss"),
|
|
39
66
|
datasetCode: z.string(),
|
|
40
67
|
geographyCodes: z.array(z.string()),
|
|
41
68
|
});
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import * as openEnums from "../../types/enums.js";
|
|
7
|
+
import { OpenEnum } from "../../types/enums.js";
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* How the returned point was derived (e.g. 'rooftop')
|
|
11
|
+
*/
|
|
12
|
+
export const GeocodePrecision = {
|
|
13
|
+
Rooftop: "rooftop",
|
|
14
|
+
StreetCentre: "street_centre",
|
|
15
|
+
Approximate: "approximate",
|
|
16
|
+
} as const;
|
|
17
|
+
/**
|
|
18
|
+
* How the returned point was derived (e.g. 'rooftop')
|
|
19
|
+
*/
|
|
20
|
+
export type GeocodePrecision = OpenEnum<typeof GeocodePrecision>;
|
|
21
|
+
|
|
22
|
+
/** @internal */
|
|
23
|
+
export const GeocodePrecision$inboundSchema: z.ZodType<
|
|
24
|
+
GeocodePrecision,
|
|
25
|
+
z.ZodTypeDef,
|
|
26
|
+
unknown
|
|
27
|
+
> = openEnums.inboundSchema(GeocodePrecision);
|
|
@@ -4,7 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
import * as z from "zod/v3";
|
|
6
6
|
import { remap as remap$ } from "../../../lib/primitives.js";
|
|
7
|
-
import {
|
|
7
|
+
import {
|
|
8
|
+
collectExtraKeys as collectExtraKeys$,
|
|
9
|
+
safeParse,
|
|
10
|
+
} from "../../../lib/schemas.js";
|
|
8
11
|
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
9
12
|
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
10
13
|
|
|
@@ -17,6 +20,11 @@ export type HistogramBucket = {
|
|
|
17
20
|
* Lower bound of this bucket (inclusive). The bucket covers [key, key + interval).
|
|
18
21
|
*/
|
|
19
22
|
key: number;
|
|
23
|
+
/**
|
|
24
|
+
* Formatted bucket key, present for date_histogram when a `format` is supplied (e.g. '2024-06').
|
|
25
|
+
*/
|
|
26
|
+
keyAsString?: string | undefined;
|
|
27
|
+
additionalProperties?: { [k: string]: any } | undefined;
|
|
20
28
|
};
|
|
21
29
|
|
|
22
30
|
/** @internal */
|
|
@@ -24,12 +32,18 @@ export const HistogramBucket$inboundSchema: z.ZodType<
|
|
|
24
32
|
HistogramBucket,
|
|
25
33
|
z.ZodTypeDef,
|
|
26
34
|
unknown
|
|
27
|
-
> =
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
35
|
+
> = collectExtraKeys$(
|
|
36
|
+
z.object({
|
|
37
|
+
doc_count: z.number(),
|
|
38
|
+
key: z.number(),
|
|
39
|
+
key_as_string: z.string().optional(),
|
|
40
|
+
}).catchall(z.any()),
|
|
41
|
+
"additionalProperties",
|
|
42
|
+
true,
|
|
43
|
+
).transform((v) => {
|
|
31
44
|
return remap$(v, {
|
|
32
45
|
"doc_count": "docCount",
|
|
46
|
+
"key_as_string": "keyAsString",
|
|
33
47
|
});
|
|
34
48
|
});
|
|
35
49
|
|
|
@@ -172,13 +172,6 @@ export * from "./epcsort.js";
|
|
|
172
172
|
export * from "./exceedancelevel.js";
|
|
173
173
|
export * from "./extendedstatsaggregationresult.js";
|
|
174
174
|
export * from "./extractioncitation.js";
|
|
175
|
-
export * from "./extractiondocumentsummary.js";
|
|
176
|
-
export * from "./extractionmortgagecharge.js";
|
|
177
|
-
export * from "./extractionnotice.js";
|
|
178
|
-
export * from "./extractionothercharge.js";
|
|
179
|
-
export * from "./extractionpayload.js";
|
|
180
|
-
export * from "./extractionproprietor.js";
|
|
181
|
-
export * from "./extractionrestriction.js";
|
|
182
175
|
export * from "./floodclimate2080.js";
|
|
183
176
|
export * from "./flooddataavailability.js";
|
|
184
177
|
export * from "./flooddefence.js";
|
|
@@ -199,6 +192,7 @@ export * from "./floodzone.js";
|
|
|
199
192
|
export * from "./framework.js";
|
|
200
193
|
export * from "./frameworkdetailresponse.js";
|
|
201
194
|
export * from "./frameworklistresponse.js";
|
|
195
|
+
export * from "./geocodeprecision.js";
|
|
202
196
|
export * from "./geographiccontext.js";
|
|
203
197
|
export * from "./geographycategorymetric.js";
|
|
204
198
|
export * from "./geographymetricslistresponse.js";
|
|
@@ -244,13 +238,16 @@ export * from "./metricscomparerequest.js";
|
|
|
244
238
|
export * from "./mitigationmeasure.js";
|
|
245
239
|
export * from "./monthlycategorystats.js";
|
|
246
240
|
export * from "./monthlycategorystatslistresponse.js";
|
|
241
|
+
export * from "./mortgagecharge.js";
|
|
247
242
|
export * from "./nearestpostcodesresponse.js";
|
|
248
243
|
export * from "./nestedaggregation.js";
|
|
244
|
+
export * from "./nestedaggregationresult.js";
|
|
249
245
|
export * from "./officer.js";
|
|
250
246
|
export * from "./officerlistresponse.js";
|
|
251
247
|
export * from "./officerresponse.js";
|
|
252
248
|
export * from "./officersummary.js";
|
|
253
249
|
export * from "./officialindex.js";
|
|
250
|
+
export * from "./othercharge.js";
|
|
254
251
|
export * from "./outcodelookupresponse.js";
|
|
255
252
|
export * from "./percentilesaggregationresult.js";
|
|
256
253
|
export * from "./person.js";
|
|
@@ -332,6 +329,7 @@ export * from "./pscresponse.js";
|
|
|
332
329
|
export * from "./pscsummary.js";
|
|
333
330
|
export * from "./rangedefinition.js";
|
|
334
331
|
export * from "./refurbishmentdata.js";
|
|
332
|
+
export * from "./registeredcharges.js";
|
|
335
333
|
export * from "./regulator.js";
|
|
336
334
|
export * from "./regulatorydomain.js";
|
|
337
335
|
export * from "./regulatoryzone.js";
|
|
@@ -357,6 +355,7 @@ export * from "./schoolvideo.js";
|
|
|
357
355
|
export * from "./searchhighlight.js";
|
|
358
356
|
export * from "./searchresponse.js";
|
|
359
357
|
export * from "./searchresult.js";
|
|
358
|
+
export * from "./searchretrieveresponse.js";
|
|
360
359
|
export * from "./security.js";
|
|
361
360
|
export * from "./siccode.js";
|
|
362
361
|
export * from "./singlevalueaggregationresult.js";
|
|
@@ -390,6 +389,7 @@ export * from "./socialmedialinks.js";
|
|
|
390
389
|
export * from "./statsaggregationresult.js";
|
|
391
390
|
export * from "./streetdescriptor.js";
|
|
392
391
|
export * from "./streetdetails.js";
|
|
392
|
+
export * from "./streetmatch.js";
|
|
393
393
|
export * from "./streetquerybycoordinates.js";
|
|
394
394
|
export * from "./streetquerybyname.js";
|
|
395
395
|
export * from "./streetquerybypostcode.js";
|
|
@@ -403,9 +403,17 @@ export * from "./tenuredata.js";
|
|
|
403
403
|
export * from "./termsaggregationresult.js";
|
|
404
404
|
export * from "./termsbucket.js";
|
|
405
405
|
export * from "./tierskipreason.js";
|
|
406
|
+
export * from "./titlecovenant.js";
|
|
406
407
|
export * from "./titledeeddocumentlistresponse.js";
|
|
407
408
|
export * from "./titledeedpurchaseresponse.js";
|
|
409
|
+
export * from "./titledocumentsummary.js";
|
|
410
|
+
export * from "./titleextractionpayload.js";
|
|
408
411
|
export * from "./titleextractionpollresponse.js";
|
|
412
|
+
export * from "./titlenotice.js";
|
|
413
|
+
export * from "./titleproprietor.js";
|
|
414
|
+
export * from "./titlerestriction.js";
|
|
415
|
+
export * from "./titleschedulenoticeoflease.js";
|
|
416
|
+
export * from "./titlesummarycounts.js";
|
|
409
417
|
export * from "./transaction.js";
|
|
410
418
|
export * from "./transactionaddress.js";
|
|
411
419
|
export * from "./transactionareafilter.js";
|