smartystreets_ruby_sdk 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 004ff7e3e907b690ae90319ec80fc5ae0a39e0110811271d0b5af96078d97a13
-  data.tar.gz: 7f4ff64365804d28130f2714583e211f9c7051849a435c35e7ad36e22c3f822a
+  metadata.gz: 2a717adaa26421afae4a9537b752f1d0fa6765481a733bdfe49fbfe4019066d1
+  data.tar.gz: a0fdc35eb728b744b311f02ee3267cb74e1278dc03f5c453672324027cd4b589
 SHA512:
-  metadata.gz: b18e712ed2d5a5bfd113fe220295a732185ddaac9ce37ef25d1e088b3b9f7d3bc9b55d9a72b9baa185548c3206c62d9a5da8b2ef77213d225c945dab406f2559
-  data.tar.gz: f78011e0d4fe74231f60534f79a967b88beb85cdeb279f59ad028cf5430fc5b264b6662d165d6dfc82fad4ccd85613c565ecd8886befd1e9ba58f82b6d3a43bc
+  metadata.gz: 4ae46059f92d3de97bc82adefee2a45aad62e34d17fba1b4d5d6b138aa85943275becdcb15832feafc1b7706649c81190ad1ffa2c3d5f9fb6aee45d3a44b8fc5
+  data.tar.gz: 13dd12de3c3ac0defae3a13e13fe8cf817b3c48bbdb489e22bdd33ca29ffffceffd3546a566e923c1009b0067e8abda532a5c66d75dd59c120654b94bebccaa7

data/Makefile

@@ -27,6 +27,9 @@ publish: package
 international_autocomplete_api:
 	cd examples && ruby international_autocomplete_example.rb
 
+international_postal_code_api:
+	cd examples && ruby international_postal_code_example.rb
+
 international_street_api:
 	cd examples && ruby international_example.rb
 
@@ -48,6 +51,6 @@ us_street_api:
 us_zipcode_api:
 	cd examples && ruby us_zipcode_single_lookup_example.rb && ruby us_zipcode_multiple_lookup_example.rb
 
-examples: international_autocomplete_api international_street_api us_autocomplete_pro_api us_enrichment_api us_extract_api us_reverse_geo_api us_street_api us_zipcode_api
+examples: international_autocomplete_api international_postal_code_api international_street_api us_autocomplete_pro_api us_enrichment_api us_extract_api us_reverse_geo_api us_street_api us_zipcode_api
 
-.PHONY: clean test dependencies package publish international_autocomplete_api international_street_api us_autocomplete_pro_api us_enrichment_api us_extract_api us_reverse_geo_api us_street_api us_zipcode_api examples
+.PHONY: clean test dependencies package publish international_autocomplete_api international_postal_code_api international_street_api us_autocomplete_pro_api us_enrichment_api us_extract_api us_reverse_geo_api us_street_api us_zipcode_api examples

data/examples/international_postal_code_example.rb

@@ -0,0 +1,59 @@
+require '../lib/smartystreets_ruby_sdk/static_credentials'
+require '../lib/smartystreets_ruby_sdk/shared_credentials'
+require '../lib/smartystreets_ruby_sdk/client_builder'
+require '../lib/smartystreets_ruby_sdk/international_postal_code/lookup'
+
+class InternationalPostalCodeExample
+  Lookup = SmartyStreets::InternationalPostalCode::Lookup
+
+  def run
+    # We recommend storing your secret keys in environment variables instead---it's safer!
+    # key = ENV['SMARTY_AUTH_WEB']
+    # referer = ENV['SMARTY_AUTH_REFERER']
+    # credentials = SmartyStreets::SharedCredentials.new(key, referer)
+
+    id = ENV['SMARTY_AUTH_ID_DEV']
+    token = ENV['SMARTY_AUTH_TOKEN_DEV']
+    credentials = SmartyStreets::StaticCredentials.new(id, token)
+
+    client = SmartyStreets::ClientBuilder.new(credentials).with_base_url("https://international-postal-code.api.rivendell.smartyops.net/lookup").build_international_postal_code_api_client
+
+    # Documentation for input fields can be found at:
+    # https://smartystreets.com/docs/cloud/international-postal-code-api
+
+    lookup = Lookup.new
+    lookup.input_id = 'ID-8675309'
+    lookup.locality = 'Sao Paulo'
+    lookup.administrative_area = 'SP'
+    lookup.country = 'Brazil'
+    lookup.postal_code = '02516'
+
+    results = client.send_lookup(lookup)
+
+    puts 'Results:'
+    puts
+    results.each_with_index do |candidate, c|
+      puts "Candidate: #{c}"
+      display(candidate.input_id)
+      display(candidate.country_iso_3)
+      display(candidate.locality)
+      display(candidate.dependent_locality)
+      display(candidate.double_dependent_locality)
+      display(candidate.sub_administrative_area)
+      display(candidate.administrative_area)
+      display(candidate.super_administrative_area)
+      display(candidate.postal_code)
+      puts
+    end
+  end
+
+  def display(value)
+    if value && value.length > 0
+      puts "  #{value}"
+    end
+  end
+end
+
+InternationalPostalCodeExample.new.run
+
+

data/lib/smartystreets_ruby_sdk/client_builder.rb

@@ -18,6 +18,7 @@ require_relative 'international_autocomplete/client'
 require_relative 'us_reverse_geo/client'
 require_relative 'us_autocomplete_pro/client'
 require_relative 'us_enrichment/client'
+require_relative 'international_postal_code/client'
 
 module SmartyStreets
   # The ClientBuilder class helps you build a client object for one of the supported SmartyStreets APIs.
@@ -32,6 +33,7 @@ module SmartyStreets
     US_ZIP_CODE_API_URL = 'https://us-zipcode.api.smarty.com/lookup'.freeze
     US_REVERSE_GEO_API_URL = 'https://us-reverse-geo.api.smarty.com/lookup'.freeze
     US_ENRICHMENT_API_URL = 'https://us-enrichment.api.smarty.com/lookup'.freeze
+    INTERNATIONAL_POSTAL_CODE_API_URL = 'https://international-postal-code.api.smarty.com/lookup'.freeze
 
     def initialize(signer)
       @signer = signer
@@ -189,6 +191,11 @@ module SmartyStreets
       USEnrichment::Client.new(build_sender, @serializer)
     end
 
+    def build_international_postal_code_api_client
+      ensure_url_prefix_not_null(INTERNATIONAL_POSTAL_CODE_API_URL)
+      InternationalPostalCode::Client.new(build_sender, @serializer)
+    end
+
     # </editor-fold>
 
     def build_sender

data/lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb

@@ -0,0 +1,35 @@
+module SmartyStreets
+  module InternationalPostalCode
+    # Represents a single candidate returned by the International Postal Code API.
+    # See https://smartystreets.com/docs/cloud/international-postal-code-api
+    class Candidate
+      attr_reader :input_id,
+                  :administrative_area,
+                  :sub_administrative_area,
+                  :super_administrative_area,
+                  :country_iso_3,
+                  :locality,
+                  :dependent_locality,
+                  :dependent_locality_name,
+                  :double_dependent_locality,
+                  :postal_code,
+                  :postal_code_extra
+
+      def initialize(obj)
+        @input_id = obj['input_id']
+        @administrative_area = obj['administrative_area']
+        @sub_administrative_area = obj['sub_administrative_area']
+        @super_administrative_area = obj['super_administrative_area']
+        @country_iso_3 = obj['country_iso_3']
+        @locality = obj['locality']
+        @dependent_locality = obj['dependent_locality']
+        @dependent_locality_name = obj['dependent_locality_name']
+        @double_dependent_locality = obj['double_dependent_locality']
+        @postal_code = obj['postal_code']
+        @postal_code_extra = obj['postal_code_extra']
+      end
+    end
+  end
+end
+
+

data/lib/smartystreets_ruby_sdk/international_postal_code/client.rb

@@ -0,0 +1,60 @@
+require_relative '../request'
+require_relative '../exceptions'
+require_relative 'candidate'
+
+module SmartyStreets
+  module InternationalPostalCode
+    # It is recommended to instantiate this class using ClientBuilder.build_international_postal_code_api_client
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the International Postal Code API and stores the result in the Lookup's results field.
+      def send_lookup(lookup)
+        raise SmartyStreets::SmartyError, 'Send() must be passed a Lookup.' if lookup.nil?
+
+        request = build_request(lookup)
+
+        response = @sender.send(request)
+
+        raise response.error if response.error
+
+        candidate_hashes = @serializer.deserialize(response.payload) || []
+        candidates = convert_candidates(candidate_hashes)
+        lookup.results = candidates
+        candidates
+      end
+
+      def build_request(lookup)
+        request = SmartyStreets::Request.new
+
+        add_parameter(request, 'input_id', lookup.input_id)
+        add_parameter(request, 'country', lookup.country)
+        add_parameter(request, 'locality', lookup.locality)
+        add_parameter(request, 'administrative_area', lookup.administrative_area)
+        add_parameter(request, 'postal_code', lookup.postal_code)
+
+        request
+      end
+
+      def convert_candidates(candidate_hashes)
+        converted = []
+        return converted if candidate_hashes.nil?
+
+        candidate_hashes.each do |obj|
+          converted.push(InternationalPostalCode::Candidate.new(obj))
+        end
+
+        converted
+      end
+
+      def add_parameter(request, key, value)
+        request.parameters[key] = value unless value.nil? or value.empty?
+      end
+    end
+  end
+end
+
+

data/lib/smartystreets_ruby_sdk/international_postal_code/lookup.rb

@@ -0,0 +1,21 @@
+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
+    class Lookup
+
+      attr_accessor :input_id, :country, :locality, :administrative_area, :postal_code, :results
+
+      def initialize
+        @input_id = nil
+        @country = nil
+        @locality = nil
+        @administrative_area = nil
+        @postal_code = nil
+        @results = []
+      end
+    end
+  end
+end
+
+

data/lib/smartystreets_ruby_sdk/international_postal_code.rb

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

data/lib/smartystreets_ruby_sdk/version.rb

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

data/lib/smartystreets_ruby_sdk.rb

@@ -25,6 +25,7 @@ require 'smartystreets_ruby_sdk/us_zipcode'
 require 'smartystreets_ruby_sdk/us_autocomplete_pro'
 require 'smartystreets_ruby_sdk/international_street'
 require 'smartystreets_ruby_sdk/international_autocomplete'
+require 'smartystreets_ruby_sdk/international_postal_code'
 require 'smartystreets_ruby_sdk/us_reverse_geo'
 
 module SmartyStreets

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.3.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-23 00:00:00.000000000 Z
+date: 2025-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,6 +93,7 @@ files:
 - docker-compose.yml
 - examples/international_autocomplete_example.rb
 - examples/international_example.rb
+- examples/international_postal_code_example.rb
 - examples/us_autocomplete_pro_example.rb
 - examples/us_enrichment_example.rb
 - examples/us_extract_example.rb
@@ -113,6 +114,10 @@ files:
 - lib/smartystreets_ruby_sdk/international_autocomplete/client.rb
 - lib/smartystreets_ruby_sdk/international_autocomplete/lookup.rb
 - lib/smartystreets_ruby_sdk/international_autocomplete/suggestion.rb
+- 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/lookup.rb
 - lib/smartystreets_ruby_sdk/international_street.rb
 - lib/smartystreets_ruby_sdk/international_street/analysis.rb
 - lib/smartystreets_ruby_sdk/international_street/candidate.rb