import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import * as components from "../components/index.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
export type GetEnrichmentAddressGlobals = {
    /**
     * Specify an API version.
     *
     * @remarks
     *
     * API versioning follows the format `vYYYY.QQ.BB`, where
     *   - `YYYY` is the year
     *   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
     *   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
     *     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
     *
     * The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
     * When no version is specified, the API defaults to `v2024.01.00`.
     */
    xMoovVersion?: string | undefined;
};
export type GetEnrichmentAddressRequest = {
    /**
     * Partial or complete address to search.
     */
    search: string;
    /**
     * Maximum number of results to return.
     */
    maxResults?: number | undefined;
    /**
     * Limits results to a list of given cities.
     */
    includeCities?: string | undefined;
    /**
     * Limits results to a list of given states.
     */
    includeStates?: string | undefined;
    /**
     * Limits results to a list of given zipcodes.
     */
    includeZipcodes?: string | undefined;
    /**
     * Exclude list of states from results. No `include` pararmeters may be used with this parameter.
     */
    excludeStates?: string | undefined;
    /**
     * Display results with the listed cities at the top.
     */
    preferCities?: string | undefined;
    /**
     * Display results with the listed states at the top.
     */
    preferStates?: string | undefined;
    /**
     * Display results with the listed zipcodes at the top.
     */
    preferZipcodes?: string | undefined;
    /**
     * Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results.
     */
    preferRatio?: number | undefined;
    /**
     *   If omitted or set to `city`, it uses the sender's IP address to determine location, then automatically adds the city and state
     *
     * @remarks
     *   to the preferCities value. This parameter takes precedence over other `include` or `exclude` parameters meaning that if it is
     *   not set to `none`, you may see addresses from areas you do not wish to see.
     */
    preferGeolocation?: string | undefined;
    /**
     * Useful for narrowing results with `addressLine2` suggestions such as `Apt` (denotes an apartment building with multiple residences).
     */
    selected?: string | undefined;
    /**
     * Include results from alternate data sources. Allowed values are `all` (non-postal addresses), or `postal` (postal addresses only).
     */
    source?: string | undefined;
};
export type GetEnrichmentAddressResponse = {
    headers: {
        [k: string]: Array<string>;
    };
    result: components.EnrichedAddressResponse;
};
/** @internal */
export declare const GetEnrichmentAddressGlobals$inboundSchema: z.ZodType<GetEnrichmentAddressGlobals, z.ZodTypeDef, unknown>;
/** @internal */
export type GetEnrichmentAddressGlobals$Outbound = {
    "X-Moov-Version"?: string | undefined;
};
/** @internal */
export declare const GetEnrichmentAddressGlobals$outboundSchema: z.ZodType<GetEnrichmentAddressGlobals$Outbound, z.ZodTypeDef, GetEnrichmentAddressGlobals>;
export declare function getEnrichmentAddressGlobalsToJSON(getEnrichmentAddressGlobals: GetEnrichmentAddressGlobals): string;
export declare function getEnrichmentAddressGlobalsFromJSON(jsonString: string): SafeParseResult<GetEnrichmentAddressGlobals, SDKValidationError>;
/** @internal */
export declare const GetEnrichmentAddressRequest$inboundSchema: z.ZodType<GetEnrichmentAddressRequest, z.ZodTypeDef, unknown>;
/** @internal */
export type GetEnrichmentAddressRequest$Outbound = {
    search: string;
    maxResults?: number | undefined;
    includeCities?: string | undefined;
    includeStates?: string | undefined;
    includeZipcodes?: string | undefined;
    excludeStates?: string | undefined;
    preferCities?: string | undefined;
    preferStates?: string | undefined;
    preferZipcodes?: string | undefined;
    preferRatio?: number | undefined;
    preferGeolocation?: string | undefined;
    selected?: string | undefined;
    source?: string | undefined;
};
/** @internal */
export declare const GetEnrichmentAddressRequest$outboundSchema: z.ZodType<GetEnrichmentAddressRequest$Outbound, z.ZodTypeDef, GetEnrichmentAddressRequest>;
export declare function getEnrichmentAddressRequestToJSON(getEnrichmentAddressRequest: GetEnrichmentAddressRequest): string;
export declare function getEnrichmentAddressRequestFromJSON(jsonString: string): SafeParseResult<GetEnrichmentAddressRequest, SDKValidationError>;
/** @internal */
export declare const GetEnrichmentAddressResponse$inboundSchema: z.ZodType<GetEnrichmentAddressResponse, z.ZodTypeDef, unknown>;
/** @internal */
export type GetEnrichmentAddressResponse$Outbound = {
    Headers: {
        [k: string]: Array<string>;
    };
    Result: components.EnrichedAddressResponse$Outbound;
};
/** @internal */
export declare const GetEnrichmentAddressResponse$outboundSchema: z.ZodType<GetEnrichmentAddressResponse$Outbound, z.ZodTypeDef, GetEnrichmentAddressResponse>;
export declare function getEnrichmentAddressResponseToJSON(getEnrichmentAddressResponse: GetEnrichmentAddressResponse): string;
export declare function getEnrichmentAddressResponseFromJSON(jsonString: string): SafeParseResult<GetEnrichmentAddressResponse, SDKValidationError>;
//# sourceMappingURL=getenrichmentaddress.d.ts.map