View Source GoogleApi.AddressValidation.V1.Api.V1 (google_api_address_validation v0.3.1)

API calls for all endpoints tagged V1.

Summary

Functions

Feedback about the outcome of the sequence of validation attempts. This should be the last call made after a sequence of validation calls for the same address, and should be called once the transaction is concluded. This should only be sent once for the sequence of ValidateAddress requests needed to validate an address fully.

Functions

Link to this function

addressvalidation_provide_validation_feedback(connection, optional_params \\ [], opts \\ [])

View Source
@spec addressvalidation_provide_validation_feedback(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AddressValidation.V1.Model.GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Feedback about the outcome of the sequence of validation attempts. This should be the last call made after a sequence of validation calls for the same address, and should be called once the transaction is concluded. This should only be sent once for the sequence of ValidateAddress requests needed to validate an address fully.

Parameters

  • connection (type: GoogleApi.AddressValidation.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AddressValidation.V1.Model.GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AddressValidation.V1.Model.GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse{}} on success
  • {:error, info} on failure
Link to this function

addressvalidation_validate_address(connection, optional_params \\ [], opts \\ [])

View Source
@spec addressvalidation_validate_address(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.AddressValidation.V1.Model.GoogleMapsAddressvalidationV1ValidateAddressResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Validates an address.

Parameters

  • connection (type: GoogleApi.AddressValidation.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AddressValidation.V1.Model.GoogleMapsAddressvalidationV1ValidateAddressRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AddressValidation.V1.Model.GoogleMapsAddressvalidationV1ValidateAddressResponse{}} on success
  • {:error, info} on failure