lob 6.0.9 → 6.1.0

data/lib/lob/models/bank_account.rb

@@ -55,6 +55,9 @@ module Lob
 
     attr_accessor :object
 
+    # The type of microdeposit verification used for this bank account. Either "amounts" or "descriptor_code", or null once verified.
+    attr_accessor :microdeposit_type
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -93,7 +96,8 @@ module Lob
         :'date_created' => :'date_created',
         :'date_modified' => :'date_modified',
         :'deleted' => :'deleted',
-        :'object' => :'object'
+        :'object' => :'object',
+        :'microdeposit_type' => :'microdeposit_type'
       }
     end
 
@@ -118,7 +122,8 @@ module Lob
         :'date_created' => :'Time',
         :'date_modified' => :'Time',
         :'deleted' => :'Boolean',
-        :'object' => :'String'
+        :'object' => :'String',
+        :'microdeposit_type' => :'String'
       }
     end
 
@@ -127,6 +132,7 @@ module Lob
       Set.new([
         :'description',
         :'signature_url',
+        :'microdeposit_type',
       ])
     end
 
@@ -206,6 +212,10 @@ module Lob
       else
         self.object = 'bank_account'
       end
+
+      if attributes.key?(:'microdeposit_type')
+        self.microdeposit_type = attributes[:'microdeposit_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -428,7 +438,8 @@ module Lob
           date_created == o.date_created &&
           date_modified == o.date_modified &&
           deleted == o.deleted &&
-          object == o.object
+          object == o.object &&
+          microdeposit_type == o.microdeposit_type
     end
 
     # @see the `==` method
@@ -440,7 +451,7 @@ module Lob
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [description, routing_number, account_number, account_type, signatory, metadata, id, signature_url, bank_name, verified, date_created, date_modified, deleted, object].hash
+      [description, routing_number, account_number, account_type, signatory, metadata, id, signature_url, bank_name, verified, date_created, date_modified, deleted, object, microdeposit_type].hash
     end
 
 

data/lib/lob/models/bank_account_verify.rb

@@ -18,10 +18,14 @@ module Lob
     # In live mode, an array containing the two micro deposits (in cents) placed in the bank account. In test mode, no micro deposits will be placed, so any two integers between `1` and `100` will work.
     attr_accessor :amounts
 
+    # The 6-character code (beginning with SM) from the bank statement descriptor of the single $0.01 microdeposit. Required when microdeposit_type is descriptor_code.
+    attr_accessor :descriptor_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'amounts' => :'amounts'
+        :'amounts' => :'amounts',
+        :'descriptor_code' => :'descriptor_code'
       }
     end
 
@@ -33,7 +37,8 @@ module Lob
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'amounts' => :'Array<Integer>'
+        :'amounts' => :'Array<Integer>',
+        :'descriptor_code' => :'String'
       }
     end
 
@@ -63,22 +68,51 @@ module Lob
           self.amounts = value
         end
       end
+
+      if attributes.key?(:'descriptor_code')
+        self.descriptor_code = attributes[:'descriptor_code']
+      end
+
+      has_amounts = !@amounts.nil?
+      has_descriptor_code = !@descriptor_code.nil?
+
+      if !has_amounts && !has_descriptor_code
+        fail ArgumentError, 'one of "amounts" or "descriptor_code" must be provided'
+      end
+
+      if has_amounts && has_descriptor_code
+        fail ArgumentError, 'only one of "amounts" or "descriptor_code" may be provided'
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @amounts.nil?
-        invalid_properties.push('invalid value for "amounts", amounts cannot be nil.')
+
+      if @amounts.nil? && @descriptor_code.nil?
+        invalid_properties.push('one of "amounts" or "descriptor_code" must be provided')
       end
 
-      if @amounts.length > 2
-        invalid_properties.push('invalid value for "amounts", number of items must be less than or equal to 2.')
+      if !@amounts.nil? && !@descriptor_code.nil?
+        invalid_properties.push('only one of "amounts" or "descriptor_code" may be provided')
+      end
+
+      if !@amounts.nil?
+        if @amounts.length > 2
+          invalid_properties.push('invalid value for "amounts", number of items must be less than or equal to 2.')
+        end
+
+        if @amounts.length < 2
+          invalid_properties.push('invalid value for "amounts", number of items must be greater than or equal to 2.')
+        end
       end
 
-      if @amounts.length < 2
-        invalid_properties.push('invalid value for "amounts", number of items must be greater than or equal to 2.')
+      if !@descriptor_code.nil?
+        pattern = Regexp.new(/^SM[a-zA-Z0-9]{4}$/)
+        if @descriptor_code !~ pattern
+          invalid_properties.push("invalid value for \"descriptor_code\", must conform to the pattern #{pattern}.")
+        end
       end
 
       invalid_properties
@@ -87,9 +121,15 @@ module Lob
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @amounts.nil?
-      return false if @amounts.length > 2
-      return false if @amounts.length < 2
+      return false if @amounts.nil? && @descriptor_code.nil?
+      return false if !@amounts.nil? && !@descriptor_code.nil?
+      if !@amounts.nil?
+        return false if @amounts.length > 2
+        return false if @amounts.length < 2
+      end
+      if !@descriptor_code.nil?
+        return false if @descriptor_code !~ Regexp.new(/^SM[a-zA-Z0-9]{4}$/)
+      end
       true
     end
 
@@ -111,12 +151,28 @@ module Lob
       @amounts = amounts
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] descriptor_code Value to be assigned
+    def descriptor_code=(descriptor_code)
+      if descriptor_code.nil?
+        fail ArgumentError, 'descriptor_code cannot be nil'
+      end
+
+      pattern = Regexp.new(/^SM[a-zA-Z0-9]{4}$/)
+      if descriptor_code !~ pattern
+        fail ArgumentError, "invalid value for \"descriptor_code\", must conform to the pattern #{pattern}."
+      end
+
+      @descriptor_code = descriptor_code
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          amounts == o.amounts
+          amounts == o.amounts &&
+          descriptor_code == o.descriptor_code
     end
 
     # @see the `==` method
@@ -128,7 +184,7 @@ module Lob
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [amounts].hash
+      [amounts, descriptor_code].hash
     end
 
 

data/lib/lob/models/intl_address.rb

@@ -42,10 +42,10 @@ module Lob
 
     attr_accessor :address_city
 
-    # 2 letter state short-name code
+    # Must be no longer than 200 characters.
     attr_accessor :address_state
 
-    # Must have a maximum of 12 characters 
+    # Must be no longer than 40 characters.
     attr_accessor :address_zip
 
     attr_accessor :address_country
@@ -294,13 +294,12 @@ module Lob
         invalid_properties.push('invalid value for "address_city", the character length must be smaller than or equal to 200.')
       end
 
-      pattern = Regexp.new(/^[a-zA-Z]{2}$/)
-      if !@address_state.nil? && @address_state !~ pattern
-        invalid_properties.push("invalid value for \"address_state\", must conform to the pattern #{pattern}.")
+      if !@address_state.nil? && @address_state.to_s.length > 200
+        invalid_properties.push('invalid value for "address_state", the character length must be smaller than or equal to 200.')
       end
 
-      if !@address_zip.nil? && @address_zip.to_s.length > 12
-        invalid_properties.push('invalid value for "address_zip", the character length must be smaller than or equal to 12.')
+      if !@address_zip.nil? && @address_zip.to_s.length > 40
+        invalid_properties.push('invalid value for "address_zip", the character length must be smaller than or equal to 40.')
       end
 
       invalid_properties
@@ -318,8 +317,8 @@ module Lob
       return false if !@address_line1.nil? && @address_line1.to_s.length > 64
       return false if !@address_line2.nil? && @address_line2.to_s.length > 64
       return false if !@address_city.nil? && @address_city.to_s.length > 200
-      return false if !@address_state.nil? && @address_state !~ Regexp.new(/^[a-zA-Z]{2}$/)
-      return false if !@address_zip.nil? && @address_zip.to_s.length > 12
+      return false if !@address_state.nil? && @address_state.to_s.length > 200
+      return false if !@address_zip.nil? && @address_zip.to_s.length > 40
       object_validator = EnumAttributeValidator.new('String', ["address"])
       return false unless object_validator.valid?(@object)
       true
@@ -425,9 +424,8 @@ module Lob
     # Custom attribute writer method with validation
     # @param [Object] address_state Value to be assigned
     def address_state=(address_state)
-      pattern = Regexp.new(/^[a-zA-Z]{2}$/)
-      if !address_state.nil? && address_state !~ pattern
-        fail ArgumentError, "invalid value for \"address_state\", must conform to the pattern #{pattern}."
+      if !address_state.nil? && address_state.to_s.length > 200
+        fail ArgumentError, 'invalid value for "address_state", the character length must be smaller than or equal to 200.'
       end
 
       @address_state = address_state
@@ -436,8 +434,8 @@ module Lob
     # Custom attribute writer method with validation
     # @param [Object] address_zip Value to be assigned
     def address_zip=(address_zip)
-      if !address_zip.nil? && address_zip.to_s.length > 12
-        fail ArgumentError, 'invalid value for "address_zip", the character length must be smaller than or equal to 12.'
+      if !address_zip.nil? && address_zip.to_s.length > 40
+        fail ArgumentError, 'invalid value for "address_zip", the character length must be smaller than or equal to 40.'
       end
 
       @address_zip = address_zip

data/lib/lob/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.2.1
 =end
 
 module Lob
-  VERSION = '6.0.9'
+  VERSION = '6.1.0'
 end

data/lib/lob.rb

@@ -65,6 +65,7 @@ require 'lob/models/cmp_schedule_type'
 require 'lob/models/cmp_use_type'
 require 'lob/models/country_extended'
 require 'lob/models/country_extended_expanded'
+require 'lob/models/country_extended_expanded_no_us'
 require 'lob/models/creative_patch'
 require 'lob/models/creative_response'
 require 'lob/models/creative_writable'
@@ -81,6 +82,7 @@ require 'lob/models/geocode_components'
 require 'lob/models/http_validation_error'
 require 'lob/models/identity_validation'
 require 'lob/models/inline_object'
+require 'lob/models/intl_address'
 require 'lob/models/intl_autocompletions'
 require 'lob/models/intl_autocompletions_writable'
 require 'lob/models/intl_components'
@@ -161,6 +163,7 @@ require 'lob/models/upload_state'
 require 'lob/models/upload_updatable'
 require 'lob/models/upload_writable'
 require 'lob/models/uploads_metadata'
+require 'lob/models/us_address'
 require 'lob/models/us_autocompletions'
 require 'lob/models/us_autocompletions_writable'
 require 'lob/models/us_components'

data/spec/api/bank_accounts_api_spec.rb

@@ -13,89 +13,122 @@ OpenAPI Generator version: 5.2.1
 require 'spec_helper'
 require 'json'
 
-# Unit tests for Lob::BankAccountsApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
 describe 'BankAccountsApi' do
   before do
-    # run before each test
     @api_instance = Lob::BankAccountsApi.new
   end
 
-  after do
-    # run after each test
-  end
-
   describe 'test an instance of BankAccountsApi' do
     it 'should create an instance of BankAccountsApi' do
       expect(@api_instance).to be_instance_of(Lob::BankAccountsApi)
     end
   end
 
-  # unit tests for bank_account_create
-  # create
-  # Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\".
-  # @param bank_account_writable 
-  # @param [Hash] opts the optional parameters
-  # @return [BankAccount]
   describe 'bank_account_create test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  # unit tests for bank_account_delete
-  # delete
-  # Permanently deletes a bank account. It cannot be undone.
-  # @param bank_id id of the bank account
-  # @param [Hash] opts the optional parameters
-  # @return [BankAccountDeletion]
   describe 'bank_account_delete test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  # unit tests for bank_account_retrieve
-  # get
-  # Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation.
-  # @param bank_id id of the bank account
-  # @param [Hash] opts the optional parameters
-  # @return [BankAccount]
   describe 'bank_account_retrieve test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  # unit tests for bank_account_verify
-  # verify
-  # Verify a bank account in order to create a check.
-  # @param bank_id id of the bank account to be verified
-  # @param bank_account_verify 
-  # @param [Hash] opts the optional parameters
-  # @return [BankAccount]
   describe 'bank_account_verify test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  # unit tests for bank_accounts_list
-  # list
-  # Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :limit How many results to return.
-  # @option opts [String] :before A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. 
-  # @option opts [String] :after A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. 
-  # @option opts [Array<String>] :include Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;. 
-  # @option opts [Hash<String, Time>] :date_created Filter by date created.
-  # @option opts [Hash<String, String>] :metadata Filter by metadata key-value pair&#x60;.
-  # @return [BankAccountList]
   describe 'bank_accounts_list test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
+  describe 'BankAccountVerify model' do
+    it 'accepts amounts' do
+      verify = Lob::BankAccountVerify.new(amounts: [11, 35])
+      expect(verify.amounts).to eq([11, 35])
+      expect(verify.descriptor_code).to be_nil
+    end
+
+    it 'accepts a valid descriptor_code' do
+      verify = Lob::BankAccountVerify.new(descriptor_code: 'SM11AA')
+      expect(verify.descriptor_code).to eq('SM11AA')
+      expect(verify.amounts).to be_nil
+    end
+
+    it 'raises when neither amounts nor descriptor_code is provided' do
+      expect {
+        Lob::BankAccountVerify.new({})
+      }.to raise_error(ArgumentError, /one of "amounts" or "descriptor_code" must be provided/)
+    end
+
+    it 'raises when both amounts and descriptor_code are provided' do
+      expect {
+        Lob::BankAccountVerify.new(amounts: [11, 35], descriptor_code: 'SM11AA')
+      }.to raise_error(ArgumentError, /only one of "amounts" or "descriptor_code" may be provided/)
+    end
+
+    it 'raises when descriptor_code does not match the pattern' do
+      expect {
+        Lob::BankAccountVerify.new(descriptor_code: 'INVALID')
+      }.to raise_error(ArgumentError, /must conform to the pattern/)
+    end
+
+    it 'raises when descriptor_code does not start with SM' do
+      expect {
+        Lob::BankAccountVerify.new(descriptor_code: 'AB1234')
+      }.to raise_error(ArgumentError, /must conform to the pattern/)
+    end
+
+    it 'raises when descriptor_code is too short' do
+      expect {
+        Lob::BankAccountVerify.new(descriptor_code: 'SM123')
+      }.to raise_error(ArgumentError, /must conform to the pattern/)
+    end
+
+    it 'raises when descriptor_code is too long' do
+      expect {
+        Lob::BankAccountVerify.new(descriptor_code: 'SM12345')
+      }.to raise_error(ArgumentError, /must conform to the pattern/)
+    end
+
+    it 'is valid with amounts' do
+      verify = Lob::BankAccountVerify.new(amounts: [11, 35])
+      expect(verify.valid?).to be true
+    end
+
+    it 'is valid with descriptor_code' do
+      verify = Lob::BankAccountVerify.new(descriptor_code: 'SM11AA')
+      expect(verify.valid?).to be true
+    end
+  end
+
+  describe 'BankAccount model microdeposit_type' do
+    it 'accepts microdeposit_type "amounts"' do
+      account = Lob::BankAccount.new(microdeposit_type: 'amounts')
+      expect(account.microdeposit_type).to eq('amounts')
+    end
+
+    it 'accepts microdeposit_type "descriptor_code"' do
+      account = Lob::BankAccount.new(microdeposit_type: 'descriptor_code')
+      expect(account.microdeposit_type).to eq('descriptor_code')
+    end
+
+    it 'defaults microdeposit_type to nil when not provided' do
+      account = Lob::BankAccount.new({})
+      expect(account.microdeposit_type).to be_nil
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: 6.0.9
+  version: 6.1.0
 platform: ruby
 authors:
 - OpenAPI-Generator
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2026-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -476,11 +476,6 @@ files:
 - lib/lob/models/zip_editable.rb
 - lib/lob/models/zip_lookup_city.rb
 - lib/lob/version.rb
-- lib/openapi_client.rb
-- lib/openapi_client/api_client.rb
-- lib/openapi_client/api_error.rb
-- lib/openapi_client/configuration.rb
-- lib/openapi_client/version.rb
 - lob.gemspec
 - spec/api/addresses_api_spec.rb
 - spec/api/bank_accounts_api_spec.rb
@@ -514,7 +509,7 @@ homepage: https://openapi-generator.tech
 licenses:
 - Unlicense
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -530,35 +525,35 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Lob Ruby Gem
 test_files:
-- spec/api/snap_packs_api_spec.rb
-- spec/api/identity_validation_api_spec.rb
-- spec/api/reverse_geocode_lookups_api_spec.rb
-- spec/api/buckslip_orders_api_spec.rb
-- spec/api/us_verifications_api_spec.rb
-- spec/api/us_autocompletions_api_spec.rb
-- spec/api/billing_groups_api_spec.rb
-- spec/api/default_api_spec.rb
+- spec/api/card_orders_api_spec.rb
 - spec/api/self_mailers_api_spec.rb
-- spec/api/zip_lookups_api_spec.rb
+- spec/api/uploads_api_spec.rb
 - spec/api/intl_verifications_api_spec.rb
-- spec/api/postcards_api_spec.rb
-- spec/api/letters_api_spec.rb
-- spec/api/template_versions_api_spec.rb
-- spec/api/intl_autocompletions_api_spec.rb
-- spec/api/bank_accounts_api_spec.rb
-- spec/api/checks_api_spec.rb
+- spec/api/creatives_api_spec.rb
+- spec/api/zip_lookups_api_spec.rb
+- spec/api/default_api_spec.rb
 - spec/api/templates_api_spec.rb
-- spec/api/cards_api_spec.rb
-- spec/api/uploads_api_spec.rb
+- spec/api/campaigns_api_spec.rb
+- spec/api/us_autocompletions_api_spec.rb
+- spec/api/checks_api_spec.rb
+- spec/api/bank_accounts_api_spec.rb
+- spec/api/buckslip_orders_api_spec.rb
+- spec/api/reverse_geocode_lookups_api_spec.rb
+- spec/api/intl_autocompletions_api_spec.rb
+- spec/api/snap_packs_api_spec.rb
 - spec/api/addresses_api_spec.rb
-- spec/api/card_orders_api_spec.rb
-- spec/api/creatives_api_spec.rb
+- spec/api/identity_validation_api_spec.rb
+- spec/api/cards_api_spec.rb
+- spec/api/us_verifications_api_spec.rb
+- spec/api/postcards_api_spec.rb
 - spec/api/buckslips_api_spec.rb
-- spec/api/campaigns_api_spec.rb
+- spec/api/billing_groups_api_spec.rb
+- spec/api/template_versions_api_spec.rb
+- spec/api/letters_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/spec_helper.rb