japanpost-api/dist/validation.d.ts

Japan Post Servive API client

import { SearchcodeRequest } from "./request/SearchcodeRequest";
import { AddresszipRequest } from "./request/AddresszipRequest";
/**
 * Prefecture code Union type (01-47)
 */
export type PrefCode = "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31" | "32" | "33" | "34" | "35" | "36" | "37" | "38" | "39" | "40" | "41" | "42" | "43" | "44" | "45" | "46" | "47";
/**
 * Validation for postal code search request
 */
export declare function validateSearchcodeRequest(request: SearchcodeRequest): void;
/**
 * Validation for address search request
 */
export declare function validateAddresszipRequest(request: AddresszipRequest): void;
/**
 * Check if a string is a valid prefecture name
 */
export declare function isValidPrefName(prefName: string): boolean;
/**
 * Get prefecture code from prefecture name
 */
export declare function getPrefCodeFromName(prefName: string): string | undefined;
/**
 * Check if prefecture code is valid
 */
export declare function isValidPrefCode(prefCode: string): prefCode is PrefCode;
//# sourceMappingURL=validation.d.ts.map