io.snapcx.avs.client.api

Class AddressValidationApi

java.lang.Object

io.snapcx.avs.client.api.AddressValidationApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-01-03T19:15:39.720-05:00")
public class AddressValidationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AddressValidationApi()
AddressValidationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
InlineResponse200	validateAddress(String userKey, String requestId, String street, String secondary, String city, String state, String zipcode) [USA] Validate Address and provide corrected addresses.
InlineResponse200	validateGlobalAddress(String userKey, String requestId, String street, String country, String secondary, String city, String state, String zipcode) Global validate Address and provide corrected addresses for all over the world.
InlineResponse2001	zipInfo(String userKey, String requestId, String city, String state, String zipcode) Gets zipcode details for a given zipcode Or get all zipcodes for given city & state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddressValidationApi

public AddressValidationApi()

AddressValidationApi

public AddressValidationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

validateAddress

public InlineResponse200 validateAddress(String userKey,
                                         String requestId,
                                         String street,
                                         String secondary,
                                         String city,
                                         String state,
                                         String zipcode)
                                  throws ApiException

[USA] Validate Address and provide corrected addresses. This API provides real time address validation. If input address is not perfect match, then it will provide possible addresses. To invoke this API, you need to have your own private api key (aka user_key). You can always sign up for FREE plan to get user_key.

Parameters:

userKey - Your private key, given after opening account with snapcx.io (required)

requestId - Any unique string identifier. Same string will be part of response header. (required)

street - Address line1. It's mandatory field. (required)

secondary - Address line2. Second line of address, as required. (optional)

city - City name. (optional)

state - 2 Char State abbrv. Example NJ, NY, CA etc. (optional)

zipcode - 5 Digit zipcode. (optional)

Returns:

InlineResponse200

Throws:

ApiException - if fails to make API call

validateGlobalAddress

public InlineResponse200 validateGlobalAddress(String userKey,
                                               String requestId,
                                               String street,
                                               String country,
                                               String secondary,
                                               String city,
                                               String state,
                                               String zipcode)
                                        throws ApiException

Global validate Address and provide corrected addresses for all over the world. This API provides real time address validation. If input address is not perfect match, then it will provide possible addresses. To invoke this API, you need to have your own private api key (aka user_key). You can always sign up for subscription plan to get user_key.

Parameters:

userKey - Your private key, given after opening account with snapcx.io (required)

requestId - Any unique string identifier. Same string will be part of response header. (required)

street - Address line1. It's mandatory field. (required)

country - Country name or ISO 3 Char country code. Example GBR, CAN, DEU etc. (required)

secondary - Address line2. Second line of address, as required. (optional)

city - City name. (optional)

state - 2 Char State abbrv. Example NJ, NY, CA etc. (optional)

zipcode - 5 Digit zipcode. (optional)

Returns:

InlineResponse200

Throws:

ApiException - if fails to make API call

zipInfo

public InlineResponse2001 zipInfo(String userKey,
                                  String requestId,
                                  String city,
                                  String state,
                                  String zipcode)
                           throws ApiException

Gets zipcode details for a given zipcode Or get all zipcodes for given city & state. This API provides zipcode lookup for a city & state or lookup city/state for a given zipcode. If city has multiple zipcode assigned, then all zipcodes are returned. To further filter, filter on zipcode->type value. To invoke this API, you need to have your own private api key (aka user_key). You can always sign up for FREE plan to get user_key.

Parameters:

userKey - Your private key, given after opening account with snapcx.io (required)

requestId - Any unique string identifier. Same string will be part of response header. (optional)

city - City name. Provide either zipcode OR both city & state. (optional)

state - 2 Char State abbrv. Example NJ, NY, CA etc. Provide either zipcode OR both city & state. (optional)

zipcode - 5 Digit zipcode. Provide either zipcode OR both city & state. (optional)

Returns:

InlineResponse2001

Throws:

ApiException - if fails to make API call