@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
59 lines • 2.36 kB
JavaScript
import { GeoCodesPostalCodesListParamsSchema, GeoCodesPostalCodesResponseSchema, GeoCodesPostalCodesListResponseSchema, } from '../schemas/geo-codes';
/**
* Creates the geoCodesPostalCodes resource methods
* OpenAPI Path: /geo-codes-postal-codes → geoCodesPostalCodes.*
* @description Postal code lookup and geocoding data
*/
export function createGeoCodesPostalCodesResource(executeRequest) {
return {
/**
* List postal codes with geocoding data
* @fullPath api.agrSite.geoCodesPostalCodes.list
* @service agr-site
* @domain geocoding
* @dataMethod geoCodesPostalCodesData.list
* @discoverable true
* @searchTerms ["postal codes", "zip codes", "geocoding", "location lookup"]
*/
list: async (params) => {
return executeRequest({
method: 'GET',
path: '/geo-codes-postal-codes',
paramsSchema: GeoCodesPostalCodesListParamsSchema,
responseSchema: GeoCodesPostalCodesListResponseSchema,
}, params);
},
/**
* Get a specific postal code by UID
* @fullPath api.agrSite.geoCodesPostalCodes.get
* @service agr-site
* @domain geocoding
* @dataMethod geoCodesPostalCodesData.get
* @discoverable true
* @searchTerms ["postal code", "zip code", "geocoding", "location"]
*/
get: async (geoCodesPostalCodesUid) => {
return executeRequest({
method: 'GET',
path: '/geo-codes-postal-codes/{geoCodesPostalCodesUid}',
responseSchema: GeoCodesPostalCodesResponseSchema,
}, undefined, { geoCodesPostalCodesUid: String(geoCodesPostalCodesUid) });
},
};
}
/**
* Creates the geoCodesPostalCodesData resource methods (data-only versions)
*/
export function createGeoCodesPostalCodesDataResource(geoCodesPostalCodes) {
return {
list: async (params) => {
const response = await geoCodesPostalCodes.list(params);
return response.data;
},
get: async (geoCodesPostalCodesUid) => {
const response = await geoCodesPostalCodes.get(geoCodesPostalCodesUid);
return response.data;
},
};
}
//# sourceMappingURL=geo-codes-postal-codes.js.map