Package io.moov.sdk.models.operations

Class GetEnrichmentAddressRequest.Builder

    • Method Detail

      • xMoovVersion

        public GetEnrichmentAddressRequest.Builder xMoovVersion​(java.lang.String xMoovVersion)
        Specify an API version.

        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.

      • xMoovVersion

        public GetEnrichmentAddressRequest.Builder xMoovVersion​(java.util.Optional<java.lang.String> xMoovVersion)
        Specify an API version.

        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.

      • includeZipcodes

        public GetEnrichmentAddressRequest.Builder includeZipcodes​(java.util.Optional<java.lang.String> includeZipcodes)
        Limits results to a list of given zipcodes.

      • excludeStates

        public GetEnrichmentAddressRequest.Builder excludeStates​(java.lang.String excludeStates)
        Exclude list of states from results. No `include` pararmeters may be used with this parameter.

      • excludeStates

        public GetEnrichmentAddressRequest.Builder excludeStates​(java.util.Optional<java.lang.String> excludeStates)
        Exclude list of states from results. No `include` pararmeters may be used with this parameter.

      • preferCities

        public GetEnrichmentAddressRequest.Builder preferCities​(java.util.Optional<java.lang.String> preferCities)
        Display results with the listed cities at the top.

      • preferStates

        public GetEnrichmentAddressRequest.Builder preferStates​(java.util.Optional<java.lang.String> preferStates)
        Display results with the listed states at the top.

      • preferZipcodes

        public GetEnrichmentAddressRequest.Builder preferZipcodes​(java.util.Optional<java.lang.String> preferZipcodes)
        Display results with the listed zipcodes at the top.

      • preferRatio

        public GetEnrichmentAddressRequest.Builder preferRatio​(long preferRatio)
        Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results.

      • preferRatio

        public GetEnrichmentAddressRequest.Builder preferRatio​(java.util.Optional<java.lang.Long> preferRatio)
        Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results.

      • preferGeolocation

        public GetEnrichmentAddressRequest.Builder preferGeolocation​(java.lang.String preferGeolocation)
        If omitted or set to `city`, it uses the sender's IP address to determine location, then automatically adds the city and state 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

        public GetEnrichmentAddressRequest.Builder preferGeolocation​(java.util.Optional<java.lang.String> preferGeolocation)
        If omitted or set to `city`, it uses the sender's IP address to determine location, then automatically adds the city and state 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.

      • selected

        public GetEnrichmentAddressRequest.Builder selected​(java.lang.String selected)
        Useful for narrowing results with `addressLine2` suggestions such as `Apt` (denotes an apartment building with multiple residences).

      • selected

        public GetEnrichmentAddressRequest.Builder selected​(java.util.Optional<java.lang.String> selected)
        Useful for narrowing results with `addressLine2` suggestions such as `Apt` (denotes an apartment building with multiple residences).

      • source

        public GetEnrichmentAddressRequest.Builder source​(java.lang.String source)
        Include results from alternate data sources. Allowed values are `all` (non-postal addresses), or `postal` (postal addresses only).

      • source

        public GetEnrichmentAddressRequest.Builder source​(java.util.Optional<java.lang.String> source)
        Include results from alternate data sources. Allowed values are `all` (non-postal addresses), or `postal` (postal addresses only).