Package io.moov.sdk.models.operations

Class GetEnrichmentAddressRequest

  • public class GetEnrichmentAddressRequest
extends java.lang.Object

    • Constructor Detail

      • GetEnrichmentAddressRequest

        public GetEnrichmentAddressRequest​(java.util.Optional<java.lang.String> xMoovVersion,
                                   java.lang.String search,
                                   java.util.Optional<java.lang.Long> maxResults,
                                   java.util.Optional<java.lang.String> includeCities,
                                   java.util.Optional<java.lang.String> includeStates,
                                   java.util.Optional<java.lang.String> includeZipcodes,
                                   java.util.Optional<java.lang.String> excludeStates,
                                   java.util.Optional<java.lang.String> preferCities,
                                   java.util.Optional<java.lang.String> preferStates,
                                   java.util.Optional<java.lang.String> preferZipcodes,
                                   java.util.Optional<java.lang.Long> preferRatio,
                                   java.util.Optional<java.lang.String> preferGeolocation,
                                   java.util.Optional<java.lang.String> selected,
                                   java.util.Optional<java.lang.String> source)

      • GetEnrichmentAddressRequest

        public GetEnrichmentAddressRequest​(java.lang.String search)

    • Method Detail

      • xMoovVersion

        public 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.

      • search

        public java.lang.String search()
        Partial or complete address to search.

      • maxResults

        public java.util.Optional<java.lang.Long> maxResults()
        Maximum number of results to return.

      • includeCities

        public java.util.Optional<java.lang.String> includeCities()
        Limits results to a list of given cities.

      • includeStates

        public java.util.Optional<java.lang.String> includeStates()
        Limits results to a list of given states.

      • includeZipcodes

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

      • excludeStates

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

      • preferCities

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

      • preferStates

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

      • preferZipcodes

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

      • preferRatio

        public 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 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 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 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).

      • withXMoovVersion

        public GetEnrichmentAddressRequest withXMoovVersion​(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.

      • withXMoovVersion

        public GetEnrichmentAddressRequest withXMoovVersion​(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.

      • withMaxResults

        public GetEnrichmentAddressRequest withMaxResults​(java.util.Optional<java.lang.Long> maxResults)
        Maximum number of results to return.

      • withIncludeCities

        public GetEnrichmentAddressRequest withIncludeCities​(java.lang.String includeCities)
        Limits results to a list of given cities.

      • withIncludeCities

        public GetEnrichmentAddressRequest withIncludeCities​(java.util.Optional<java.lang.String> includeCities)
        Limits results to a list of given cities.

      • withIncludeStates

        public GetEnrichmentAddressRequest withIncludeStates​(java.lang.String includeStates)
        Limits results to a list of given states.

      • withIncludeStates

        public GetEnrichmentAddressRequest withIncludeStates​(java.util.Optional<java.lang.String> includeStates)
        Limits results to a list of given states.

      • withIncludeZipcodes

        public GetEnrichmentAddressRequest withIncludeZipcodes​(java.lang.String includeZipcodes)
        Limits results to a list of given zipcodes.

      • withIncludeZipcodes

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

      • withExcludeStates

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

      • withExcludeStates

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

      • withPreferCities

        public GetEnrichmentAddressRequest withPreferCities​(java.lang.String preferCities)
        Display results with the listed cities at the top.

      • withPreferCities

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

      • withPreferStates

        public GetEnrichmentAddressRequest withPreferStates​(java.lang.String preferStates)
        Display results with the listed states at the top.

      • withPreferStates

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

      • withPreferZipcodes

        public GetEnrichmentAddressRequest withPreferZipcodes​(java.lang.String preferZipcodes)
        Display results with the listed zipcodes at the top.

      • withPreferZipcodes

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

      • withPreferRatio

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

      • withPreferRatio

        public GetEnrichmentAddressRequest withPreferRatio​(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.

      • withPreferGeolocation

        public GetEnrichmentAddressRequest withPreferGeolocation​(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.

      • withPreferGeolocation

        public GetEnrichmentAddressRequest withPreferGeolocation​(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.

      • withSelected

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

      • withSelected

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

      • withSource

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

      • withSource

        public GetEnrichmentAddressRequest withSource​(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).

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object