smartystreets_ruby_sdk 10.1.0 → 10.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 451e124efa79d87aed1df0f4a4a595b698463835d8ffc4461168d439da9e2b56
-  data.tar.gz: dbd7c8c731275bd1bc62e8fb0cc0e930e18ad0ce886b26e8bd570f84f0a4f4a7
+  metadata.gz: cb6d942045e702488251e2568a2130c99ded17b618bb2f944ad158f46ea8e5d1
+  data.tar.gz: 52fb7c510cf53f0730847da505e26b98b8c6c7b2bc904acf774533d3486964c3
 SHA512:
-  metadata.gz: 8e4c92f2f87638cfb7ae504599040b5745eec1d6553333409648077e5962d112f5d66a771435a78f3701d12e555d034e6821ad7d690fc97aa45214923f4b42e1
-  data.tar.gz: e3c2516ec819aab127324cd4ae3f211e2ec1fe363a80aa2ff490993ce3b0859cccc85c2b99244080f95b90b5ef67d32d93c104e7afd171922b50a7490eb79fdc
+  metadata.gz: '09b6013d45389218d20f30509f2f5fdf3e1111fa4838dbbe41da354bbc21a92441d64ebdfb0a2c03adf474e4a7ede41f61f50be1bc27a93b501f6836c4013da8'
+  data.tar.gz: de761e143d3ff251d1a174e3e210a308844d9b0c67e11289577b8de050f39e98297648d7fa6417e91c9b23f11d67ad75d5629a9d67f5144087b13d6fc1776278

data/examples/international_example.rb

@@ -34,6 +34,7 @@ class InternationalExample
     lookup.administrative_area = 'SP'
     lookup.country = 'Brazil'
     lookup.postal_code = '02516-050'
+    # lookup.max_results = 5 # Optional: maximum number of candidates to return
 
     # lookup.add_custom_parameter('parameter', 'value')
 

data/examples/international_postal_code_example.rb

@@ -28,6 +28,8 @@ class InternationalPostalCodeExample
     lookup.administrative_area = 'SP'
     lookup.country = 'Brazil'
     lookup.postal_code = '02516'
+    # lookup.language = SmartyStreets::InternationalPostalCode::LanguageMode::LATIN # Optional: 'native' or 'latin'
+    # lookup.max_results = 10 # Optional: maximum number of candidates to return
 
     results = client.send_lookup(lookup)
 
@@ -44,6 +46,7 @@ class InternationalPostalCodeExample
       display(candidate.administrative_area)
       display(candidate.super_administrative_area)
       display(candidate.postal_code)
+      display(candidate.thoroughfare)
       puts
     end
   end

data/lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb

@@ -13,7 +13,8 @@ module SmartyStreets
                   :dependent_locality_name,
                   :double_dependent_locality,
                   :postal_code,
-                  :postal_code_extra
+                  :postal_code_extra,
+                  :thoroughfare
 
       def initialize(obj)
         @input_id = obj['input_id']
@@ -27,6 +28,7 @@ module SmartyStreets
         @double_dependent_locality = obj['double_dependent_locality']
         @postal_code = obj['postal_code']
         @postal_code_extra = obj['postal_code_extra']
+        @thoroughfare = obj['thoroughfare']
       end
     end
   end

data/lib/smartystreets_ruby_sdk/international_postal_code/client.rb

@@ -1,6 +1,8 @@
 require_relative '../request'
 require_relative '../exceptions'
 require_relative 'candidate'
+require_relative 'language_mode'
+require_relative '../max_results'
 
 module SmartyStreets
   module InternationalPostalCode
@@ -35,6 +37,8 @@ module SmartyStreets
         add_parameter(request, 'locality', lookup.locality)
         add_parameter(request, 'administrative_area', lookup.administrative_area)
         add_parameter(request, 'postal_code', lookup.postal_code)
+        add_parameter(request, 'language', normalized_language(lookup.language))
+        add_parameter(request, 'max_results', MaxResults.normalize(lookup.max_results))
 
         request
       end
@@ -53,6 +57,12 @@ module SmartyStreets
       def add_parameter(request, key, value)
         request.parameters[key] = value unless value.nil? or value.empty?
       end
+
+      def normalized_language(language)
+        return nil if language.nil?
+
+        LanguageMode.from_value(language).value
+      end
     end
   end
 end

data/lib/smartystreets_ruby_sdk/international_postal_code/language_mode.rb

@@ -0,0 +1,26 @@
+require_relative '../exceptions'
+
+module SmartyStreets
+  module InternationalPostalCode
+    # A closed set of valid Language values, the closest Ruby equivalent to an enum: a fixed set of frozen
+    # instances rather than an arbitrary string.
+    class LanguageMode < Data.define(:value)
+      NATIVE = new('native')
+      LATIN = new('latin')
+
+      ALL = [NATIVE, LATIN].freeze
+
+      # Resolves a LanguageMode instance or a raw value (eg. from user input or config) into a LanguageMode,
+      # matching 'native'/'latin' regardless of case.
+      def self.from_value(value)
+        return value if value.is_a?(LanguageMode)
+
+        match = ALL.find { |mode| mode.value.casecmp?(value.to_s) }
+        raise SmartyStreets::UnprocessableEntityError,
+              "invalid Language value; must be unset, 'native', or 'latin' (case-insensitive)" if match.nil?
+
+        match
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/international_postal_code/lookup.rb

@@ -2,9 +2,15 @@ module SmartyStreets
   module InternationalPostalCode
     # Holds the input data for a postal code lookup and the results returned by the API.
     # See https://smartystreets.com/docs/cloud/international-postal-code-api
+    #
+    # @language:: When not set, results are returned using the Latin character set.
+    #     When set to language_mode.NATIVE (JPN only), results are returned in the native character set for that country.
+    #     When set to language_mode.LATIN, results use the Latin character set with accents and other diacritics removed.
+    # @max_results:: Optional. The maximum number of candidates to return. Omitted from the request when unset or 0.
     class Lookup
 
-      attr_accessor :input_id, :country, :locality, :administrative_area, :postal_code, :results
+      attr_accessor :input_id, :country, :locality, :administrative_area, :postal_code, :language, :max_results,
+                    :results
 
       def initialize
         @input_id = nil
@@ -12,6 +18,8 @@ module SmartyStreets
         @locality = nil
         @administrative_area = nil
         @postal_code = nil
+        @language = nil
+        @max_results = nil
         @results = []
       end
     end

data/lib/smartystreets_ruby_sdk/international_postal_code.rb

@@ -1,5 +1,6 @@
 require 'smartystreets_ruby_sdk/international_postal_code/lookup'
 require 'smartystreets_ruby_sdk/international_postal_code/candidate'
 require 'smartystreets_ruby_sdk/international_postal_code/client'
+require 'smartystreets_ruby_sdk/international_postal_code/language_mode'
 
 

data/lib/smartystreets_ruby_sdk/international_street/client.rb

@@ -1,6 +1,7 @@
 require_relative '../request'
 require_relative 'candidate'
 require_relative 'language_mode'
+require_relative '../max_results'
 
 module SmartyStreets
   module InternationalStreet
@@ -57,6 +58,7 @@ module SmartyStreets
         add_parameter(request, 'administrative_area', lookup.administrative_area)
         add_parameter(request, 'postal_code', lookup.postal_code)
         add_parameter(request, 'features', lookup.features)
+        add_parameter(request, 'max_results', MaxResults.normalize(lookup.max_results))
 
         for key in lookup.custom_param_hash.keys do
           add_parameter(request, key, lookup.custom_param_hash[key])

data/lib/smartystreets_ruby_sdk/international_street/lookup.rb

@@ -14,11 +14,12 @@ module SmartyStreets
     # @language:: When not set, the output language will match the language of the input values.
     #     When set to language_mode.NATIVE, the results will always be in the language of the output country.
     #     When set to language_mode.LATIN, the results will always be provided using a Latin character set.
+    # @max_results:: Optional. The maximum number of candidates to return. Omitted from the request when unset or 0.
     class Lookup
 
       attr_accessor :input_id, :freeform, :locality, :postal_code, :address3, :address2, :inputId, :address1,
                     :geocode, :administrative_area, :country, :organization, :language, :address4, :result,
-                    :features, :custom_param_hash
+                    :features, :max_results, :custom_param_hash
 
       def initialize(freeform=nil, country=nil)
         @result = []
@@ -37,6 +38,7 @@ module SmartyStreets
         @administrative_area = nil
         @postal_code = nil
         @features = nil
+        @max_results = nil
         @custom_param_hash = {}
       end
 

data/lib/smartystreets_ruby_sdk/max_results.rb

@@ -0,0 +1,23 @@
+require_relative 'exceptions'
+
+module SmartyStreets
+  # Shared handling for the max_results input: accepts a whole number (or a string holding one),
+  # and returns it as a string only when it is above 0, so it can be sent as a query parameter.
+  # Unset (nil or blank) returns nil; anything that isn't a whole number raises.
+  module MaxResults
+    WHOLE_NUMBER = /\A\s*[+-]?\d+\s*\z/
+
+    def self.normalize(value)
+      return nil if value.nil? || (value.is_a?(String) && value.strip.empty?)
+
+      number = case value
+               when Integer then value
+               when Float then value.to_i if value.finite? && value == value.floor
+               when String then value.to_i if value.match?(WHOLE_NUMBER)
+               end
+      raise SmartyStreets::UnprocessableEntityError, 'invalid max_results value; must be a whole number' if number.nil?
+
+      number.positive? ? number.to_s : nil
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '10.1.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '10.2.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 10.1.0
+  version: 10.2.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-01 00:00:00.000000000 Z
+date: 2026-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,6 +129,7 @@ files:
 - lib/smartystreets_ruby_sdk/international_postal_code.rb
 - lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb
 - lib/smartystreets_ruby_sdk/international_postal_code/client.rb
+- lib/smartystreets_ruby_sdk/international_postal_code/language_mode.rb
 - lib/smartystreets_ruby_sdk/international_postal_code/lookup.rb
 - lib/smartystreets_ruby_sdk/international_street.rb
 - lib/smartystreets_ruby_sdk/international_street/analysis.rb
@@ -143,6 +144,7 @@ files:
 - lib/smartystreets_ruby_sdk/json_able.rb
 - lib/smartystreets_ruby_sdk/license_sender.rb
 - lib/smartystreets_ruby_sdk/logger.rb
+- lib/smartystreets_ruby_sdk/max_results.rb
 - lib/smartystreets_ruby_sdk/native_sender.rb
 - lib/smartystreets_ruby_sdk/native_serializer.rb
 - lib/smartystreets_ruby_sdk/proxy.rb