/// <summary>
/// Address Suggestion This operation returns suggested addresses. Use this if the [Address Validation API](https://shipping.pitneybowes.com/api/post-address-verify.html) call has returned an error.
/// </summary>
/// <exception cref="shippingapi.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="returnSuggestions">To return suggested addresses, set this to true.</param>
/// <param name="addressVerifySuggest">Address object that needs to be validated.</param>
/// <param name="xPBUnifiedErrorStructure">Set this to true to use the standard [error object](https://shipping.pitneybowes.com/reference/error-object.html#standard-error-object) if an error occurs. (optional, default to true)</param>
/// <returns>Task of AddressSuggestionResponse</returns>
public async System.Threading.Tasks.Task <AddressSuggestionResponse> VerifyAndSuggestAddressAsync(string returnSuggestions, AddressVerifySuggest addressVerifySuggest, bool?xPBUnifiedErrorStructure = default(bool?))
{
ApiResponse <AddressSuggestionResponse> localVarResponse = await VerifyAndSuggestAddressAsyncWithHttpInfo(returnSuggestions, addressVerifySuggest, xPBUnifiedErrorStructure);
return(localVarResponse.Data);
}
/// <summary>
/// Address Suggestion This operation returns suggested addresses. Use this if the [Address Validation API](https://shipping.pitneybowes.com/api/post-address-verify.html) call has returned an error.
/// </summary>
/// <exception cref="shippingapi.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="returnSuggestions">To return suggested addresses, set this to true.</param>
/// <param name="addressVerifySuggest">Address object that needs to be validated.</param>
/// <param name="xPBUnifiedErrorStructure">Set this to true to use the standard [error object](https://shipping.pitneybowes.com/reference/error-object.html#standard-error-object) if an error occurs. (optional, default to true)</param>
/// <returns>Task of ApiResponse (AddressSuggestionResponse)</returns>
public async System.Threading.Tasks.Task <ApiResponse <AddressSuggestionResponse> > VerifyAndSuggestAddressAsyncWithHttpInfo(string returnSuggestions, AddressVerifySuggest addressVerifySuggest, bool?xPBUnifiedErrorStructure = default(bool?))
{
// verify the required parameter 'returnSuggestions' is set
if (returnSuggestions == null)
{
throw new ApiException(400, "Missing required parameter 'returnSuggestions' when calling AddressValidationApi->VerifyAndSuggestAddress");
}
// verify the required parameter 'addressVerifySuggest' is set
if (addressVerifySuggest == null)
{
throw new ApiException(400, "Missing required parameter 'addressVerifySuggest' when calling AddressValidationApi->VerifyAndSuggestAddress");
}
var localVarPath = "/v1/addresses/verify-suggest";
var localVarPathParams = new Dictionary <String, String>();
var localVarQueryParams = new List <KeyValuePair <String, String> >();
var localVarHeaderParams = new Dictionary <String, String>(this.Configuration.DefaultHeader);
var localVarFormParams = new Dictionary <String, String>();
var localVarFileParams = new Dictionary <String, FileParameter>();
Object localVarPostBody = null;
// to determine the Content-Type header
String[] localVarHttpContentTypes = new String[] {
"application/json"
};
String localVarHttpContentType = this.Configuration.ApiClient.SelectHeaderContentType(localVarHttpContentTypes);
// to determine the Accept header
String[] localVarHttpHeaderAccepts = new String[] {
"application/json"
};
String localVarHttpHeaderAccept = this.Configuration.ApiClient.SelectHeaderAccept(localVarHttpHeaderAccepts);
if (localVarHttpHeaderAccept != null)
{
localVarHeaderParams.Add("Accept", localVarHttpHeaderAccept);
}
if (returnSuggestions != null)
{
localVarQueryParams.AddRange(this.Configuration.ApiClient.ParameterToKeyValuePairs("", "returnSuggestions", returnSuggestions)); // query parameter
}
if (xPBUnifiedErrorStructure != null)
{
localVarHeaderParams.Add("X-PB-UnifiedErrorStructure", this.Configuration.ApiClient.ParameterToString(xPBUnifiedErrorStructure)); // header parameter
}
if (addressVerifySuggest != null && addressVerifySuggest.GetType() != typeof(byte[]))
{
localVarPostBody = this.Configuration.ApiClient.Serialize(addressVerifySuggest); // http body (model) parameter
}
else
{
localVarPostBody = addressVerifySuggest; // byte array
}
// authentication (oAuth2ClientCredentials) required
// oauth required
if (!String.IsNullOrEmpty(this.Configuration.AccessToken))
{
localVarHeaderParams["Authorization"] = "Bearer " + this.Configuration.AccessToken;
}
// make the HTTP request
IRestResponse localVarResponse = (IRestResponse)await this.Configuration.ApiClient.CallApiAsync(localVarPath,
Method.POST, localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarFileParams,
localVarPathParams, localVarHttpContentType);
int localVarStatusCode = (int)localVarResponse.StatusCode;
if (ExceptionFactory != null)
{
Exception exception = ExceptionFactory("VerifyAndSuggestAddress", localVarResponse);
if (exception != null)
{
throw exception;
}
}
return(new ApiResponse <AddressSuggestionResponse>(localVarStatusCode,
localVarResponse.Headers.ToDictionary(x => x.Name, x => string.Join(",", x.Value)),
(AddressSuggestionResponse)this.Configuration.ApiClient.Deserialize(localVarResponse, typeof(AddressSuggestionResponse))));
}
/// <summary>
/// Address Suggestion This operation returns suggested addresses. Use this if the [Address Validation API](https://shipping.pitneybowes.com/api/post-address-verify.html) call has returned an error.
/// </summary>
/// <exception cref="shippingapi.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="returnSuggestions">To return suggested addresses, set this to true.</param>
/// <param name="addressVerifySuggest">Address object that needs to be validated.</param>
/// <param name="xPBUnifiedErrorStructure">Set this to true to use the standard [error object](https://shipping.pitneybowes.com/reference/error-object.html#standard-error-object) if an error occurs. (optional, default to true)</param>
/// <returns>AddressSuggestionResponse</returns>
public AddressSuggestionResponse VerifyAndSuggestAddress(string returnSuggestions, AddressVerifySuggest addressVerifySuggest, bool?xPBUnifiedErrorStructure = default(bool?))
{
ApiResponse <AddressSuggestionResponse> localVarResponse = VerifyAndSuggestAddressWithHttpInfo(returnSuggestions, addressVerifySuggest, xPBUnifiedErrorStructure);
return(localVarResponse.Data);
}
