@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
47 lines • 2.3 kB
TypeScript
import type { EndpointConfig } from '../../../core/base-client';
import { type GeoCodesPostalCodesListParams, type GeoCodesPostalCodesResponse, type GeoCodesPostalCodesListResponse } from '../schemas/geo-codes';
type ExecuteRequest = <TParams, TResponse>(config: EndpointConfig<TParams, TResponse>, params?: TParams, pathParams?: Record<string, string>) => Promise<TResponse>;
/**
* Creates the geoCodesPostalCodes resource methods
* OpenAPI Path: /geo-codes-postal-codes → geoCodesPostalCodes.*
* @description Postal code lookup and geocoding data
*/
export declare function createGeoCodesPostalCodesResource(executeRequest: ExecuteRequest): {
/**
* 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: (params?: GeoCodesPostalCodesListParams) => Promise<GeoCodesPostalCodesListResponse>;
/**
* 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: (geoCodesPostalCodesUid: number) => Promise<GeoCodesPostalCodesResponse>;
};
/**
* Creates the geoCodesPostalCodesData resource methods (data-only versions)
*/
export declare function createGeoCodesPostalCodesDataResource(geoCodesPostalCodes: ReturnType<typeof createGeoCodesPostalCodesResource>): {
list: (params?: GeoCodesPostalCodesListParams) => Promise<import("zod").objectOutputType<{
geoCodesPostalCodesUid: import("zod").ZodNumber;
}, import("zod").ZodTypeAny, "passthrough">[]>;
get: (geoCodesPostalCodesUid: number) => Promise<{
geoCodesPostalCodesUid: number;
} & {
[k: string]: unknown;
}>;
};
export type GeoCodesPostalCodesResource = ReturnType<typeof createGeoCodesPostalCodesResource>;
export type GeoCodesPostalCodesDataResource = ReturnType<typeof createGeoCodesPostalCodesDataResource>;
export {};
//# sourceMappingURL=geo-codes-postal-codes.d.ts.map