Module: SmartyStreets

Defined in:: lib/smartystreets_ruby_sdk.rb,
lib/smartystreets_ruby_sdk/batch.rb,
lib/smartystreets_ruby_sdk/proxy.rb,
lib/smartystreets_ruby_sdk/errors.rb,
lib/smartystreets_ruby_sdk/logger.rb,
lib/smartystreets_ruby_sdk/request.rb,
lib/smartystreets_ruby_sdk/sleeper.rb,
lib/smartystreets_ruby_sdk/version.rb,
lib/smartystreets_ruby_sdk/response.rb,
lib/smartystreets_ruby_sdk/json_able.rb,
lib/smartystreets_ruby_sdk/us_street.rb,
lib/smartystreets_ruby_sdk/exceptions.rb,
lib/smartystreets_ruby_sdk/us_extract.rb,
lib/smartystreets_ruby_sdk/us_zipcode.rb,
lib/smartystreets_ruby_sdk/retry_sender.rb,
lib/smartystreets_ruby_sdk/native_sender.rb,
lib/smartystreets_ruby_sdk/us_enrichment.rb,
lib/smartystreets_ruby_sdk/client_builder.rb,
lib/smartystreets_ruby_sdk/license_sender.rb,
lib/smartystreets_ruby_sdk/signing_sender.rb,
lib/smartystreets_ruby_sdk/us_reverse_geo.rb,
lib/smartystreets_ruby_sdk/us_zipcode/city.rb,
lib/smartystreets_ruby_sdk/us_street/client.rb,
lib/smartystreets_ruby_sdk/us_street/lookup.rb,
lib/smartystreets_ruby_sdk/native_serializer.rb,
lib/smartystreets_ruby_sdk/url_prefix_sender.rb,
lib/smartystreets_ruby_sdk/us_extract/client.rb,
lib/smartystreets_ruby_sdk/us_extract/lookup.rb,
lib/smartystreets_ruby_sdk/us_extract/result.rb,
lib/smartystreets_ruby_sdk/us_zipcode/client.rb,
lib/smartystreets_ruby_sdk/us_zipcode/lookup.rb,
lib/smartystreets_ruby_sdk/us_zipcode/result.rb,
lib/smartystreets_ruby_sdk/shared_credentials.rb,
lib/smartystreets_ruby_sdk/static_credentials.rb,
lib/smartystreets_ruby_sdk/status_code_sender.rb,
lib/smartystreets_ruby_sdk/us_extract/address.rb,
lib/smartystreets_ruby_sdk/us_street/analysis.rb,
lib/smartystreets_ruby_sdk/us_street/metadata.rb,
lib/smartystreets_ruby_sdk/us_autocomplete_pro.rb,
lib/smartystreets_ruby_sdk/us_extract/metadata.rb,
lib/smartystreets_ruby_sdk/us_street/candidate.rb,
lib/smartystreets_ruby_sdk/us_zipcode/zip_code.rb,
lib/smartystreets_ruby_sdk/custom_header_sender.rb,
lib/smartystreets_ruby_sdk/international_street.rb,
lib/smartystreets_ruby_sdk/us_enrichment/client.rb,
lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb,
lib/smartystreets_ruby_sdk/us_street/components.rb,
lib/smartystreets_ruby_sdk/us_street/match_type.rb,
lib/smartystreets_ruby_sdk/us_reverse_geo/client.rb,
lib/smartystreets_ruby_sdk/us_reverse_geo/lookup.rb,
lib/smartystreets_ruby_sdk/us_reverse_geo/result.rb,
lib/smartystreets_ruby_sdk/us_reverse_geo/address.rb,
lib/smartystreets_ruby_sdk/us_reverse_geo/coordinate.rb,
lib/smartystreets_ruby_sdk/international_autocomplete.rb,
lib/smartystreets_ruby_sdk/us_autocomplete_pro/client.rb,
lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup.rb,
lib/smartystreets_ruby_sdk/international_street/client.rb,
lib/smartystreets_ruby_sdk/international_street/lookup.rb,
lib/smartystreets_ruby_sdk/us_zipcode/alternate_county.rb,
lib/smartystreets_ruby_sdk/international_street/changes.rb,
lib/smartystreets_ruby_sdk/international_street/analysis.rb,
lib/smartystreets_ruby_sdk/international_street/metadata.rb,
lib/smartystreets_ruby_sdk/international_street/candidate.rb,
lib/smartystreets_ruby_sdk/international_street/rootlevel.rb,
lib/smartystreets_ruby_sdk/us_autocomplete_pro/suggestion.rb,
lib/smartystreets_ruby_sdk/us_enrichment/secondary/lookup.rb,
lib/smartystreets_ruby_sdk/international_street/components.rb,
lib/smartystreets_ruby_sdk/us_enrichment/secondary/response.rb,
lib/smartystreets_ruby_sdk/international_autocomplete/client.rb,
lib/smartystreets_ruby_sdk/international_autocomplete/lookup.rb,
lib/smartystreets_ruby_sdk/international_street/language_mode.rb,
lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/lookup.rb,
lib/smartystreets_ruby_sdk/us_autocomplete_pro/geolocation_type.rb,
lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/response.rb,
lib/smartystreets_ruby_sdk/us_enrichment/secondary/count/lookup.rb,
lib/smartystreets_ruby_sdk/international_autocomplete/suggestion.rb,
lib/smartystreets_ruby_sdk/us_enrichment/secondary/aliases_entry.rb,
lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/attributes.rb,
lib/smartystreets_ruby_sdk/us_enrichment/secondary/count/response.rb,
lib/smartystreets_ruby_sdk/us_reverse_geo/us_reverse_geo_response.rb,
lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/place_entry.rb,
lib/smartystreets_ruby_sdk/us_enrichment/property/financial/lookup.rb,
lib/smartystreets_ruby_sdk/us_enrichment/property/principal/lookup.rb,
lib/smartystreets_ruby_sdk/us_enrichment/property/financial/response.rb,
lib/smartystreets_ruby_sdk/us_enrichment/property/principal/response.rb,
lib/smartystreets_ruby_sdk/us_enrichment/secondary/secondaries_entry.rb,
lib/smartystreets_ruby_sdk/us_enrichment/secondary/root_address_entry.rb,
lib/smartystreets_ruby_sdk/us_enrichment/property/financial/attributes.rb,
lib/smartystreets_ruby_sdk/us_enrichment/property/principal/attributes.rb,
lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/census_block_entry.rb,
lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/census_tract_entry.rb,
lib/smartystreets_ruby_sdk/us_enrichment/property/financial/history_entry.rb,
lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/core_based_stat_area_entry.rb,
lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/census_county_division_entry.rb

Defined Under Namespace

Modules: InternationalAutocomplete, InternationalStreet, USAutocompletePro, USEnrichment, USExtract, USReverseGeo, USStreet, USZipcode Classes: BadCredentialsError, BadRequestError, Batch, BatchFullError, ClientBuilder, CustomHeaderSender, ForbiddenError, GatewayTimeoutError, InternalServerError, JSONAble, LicenseSender, Logger, NativeSender, NativeSerializer, NotModifiedInfo, PaymentRequiredError, Proxy, Request, RequestEntityTooLargeError, Response, RetrySender, ServiceUnavailableError, SharedCredentials, SigningSender, Sleeper, SmartyError, StaticCredentials, StatusCodeSender, TooManyRequestsError, URLPrefixSender, UnprocessableEntityError

Constant Summary collapse

NOT_MODIFIED =

'Not Modified: This data has not been modified since the last request. Please remove the etag header to fetch this data'.freeze

BAD_CREDENTIALS =

'Unauthorized: The credentials were provided incorrectly or did not match any existing,
active credentials.'.freeze

PAYMENT_REQUIRED =

'Payment Required: There is no active subscription
for the account associated with the credentials submitted with the request.'.freeze

FORBIDDEN =

'Because the international service is currently in a limited release phase, only approved accounts' \
' may access the service.'.freeze

REQUEST_ENTITY_TOO_LARGE =

'Request Entity Too Large: The request body has exceeded the maximum size.'.freeze

BAD_REQUEST =

'Bad Request (Malformed Payload): A GET request lacked a street field or the request body of a
POST request contained malformed JSON, possibly because a value was submitted as a number rather than as a string.'.freeze

UNPROCESSABLE_ENTITY =

'GET request lacked required fields.'.freeze

TOO_MANY_REQUESTS =

'The rate limit has been exceeded.'.freeze

INTERNAL_SERVER_ERROR =

'Internal Server Error.'.freeze

SERVICE_UNAVAILABLE =

'Service Unavailable. Try again later.'.freeze

GATEWAY_TIMEOUT =

'The upstream data provider did not respond in a timely fashion and the request failed. ' \
'A serious, yet rare occurrence indeed.'.freeze

VERSION = DO NOT EDIT (this is updated by a build job when a new release is published)

'5.20.4'