increase 1.340.0 → 1.342.0

data/rbi/increase/models/beneficial_owner_update_params.rbi

@@ -152,14 +152,18 @@ module Increase
         sig { returns(String) }
         attr_accessor :city
 
-        # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-        sig { returns(String) }
-        attr_accessor :country
-
         # The first line of the address. This is usually the street number and street.
         sig { returns(String) }
         attr_accessor :line1
 
+        # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+        # to `US`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :country
+
+        sig { params(country: String).void }
+        attr_writer :country
+
         # The second line of the address. This might be the floor or room number.
         sig { returns(T.nilable(String)) }
         attr_reader :line2
@@ -187,8 +191,8 @@ module Increase
         sig do
           params(
             city: String,
-            country: String,
             line1: String,
+            country: String,
             line2: String,
             state: String,
             zip: String
@@ -197,10 +201,11 @@ module Increase
         def self.new(
           # The city, district, town, or village of the address.
           city:,
-          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-          country:,
           # The first line of the address. This is usually the street number and street.
           line1:,
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+          # to `US`.
+          country: nil,
           # The second line of the address. This might be the floor or room number.
           line2: nil,
           # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -215,8 +220,8 @@ module Increase
           override.returns(
             {
               city: String,
-              country: String,
               line1: String,
+              country: String,
               line2: String,
               state: String,
               zip: String

data/rbi/increase/models/check_transfer.rbi

@@ -813,6 +813,10 @@ module Increase
         end
         attr_writer :return_address
 
+        # A custom name printed above the Increase-managed return address.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :return_address_name
+
         # The shipping method for the check.
         sig do
           returns(
@@ -832,7 +836,8 @@ module Increase
         end
         attr_writer :signature
 
-        # Tracking updates relating to the physical check's delivery.
+        # Tracking updates relating to the physical check's delivery. Sorted by
+        # `created_at` in ascending order.
         sig do
           returns(
             T::Array[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate]
@@ -857,6 +862,7 @@ module Increase
               T.nilable(
                 Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash
               ),
+            return_address_name: T.nilable(String),
             shipping_method:
               Increase::CheckTransfer::PhysicalCheck::ShippingMethod::OrSymbol,
             signature:
@@ -885,11 +891,14 @@ module Increase
           recipient_name:,
           # The return address to be printed on the check.
           return_address:,
+          # A custom name printed above the Increase-managed return address.
+          return_address_name:,
           # The shipping method for the check.
           shipping_method:,
           # The signature that will appear on the check.
           signature:,
-          # Tracking updates relating to the physical check's delivery.
+          # Tracking updates relating to the physical check's delivery. Sorted by
+          # `created_at` in ascending order.
           tracking_updates:
         )
         end
@@ -909,6 +918,7 @@ module Increase
                 T.nilable(
                   Increase::CheckTransfer::PhysicalCheck::ReturnAddress
                 ),
+              return_address_name: T.nilable(String),
               shipping_method:
                 Increase::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol,
               signature: Increase::CheckTransfer::PhysicalCheck::Signature,

data/rbi/increase/models/check_transfer_create_params.rbi

@@ -288,6 +288,16 @@ module Increase
         sig { returns(String) }
         attr_accessor :memo
 
+        # The payer of the check. This will be printed on the top-left portion of the
+        # check. This should be an array of up to 4 elements, each of which represents a
+        # line of the payer.
+        sig do
+          returns(
+            T::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer]
+          )
+        end
+        attr_accessor :payer
+
         # The name that will be printed on the check in the 'To:' field.
         sig { returns(String) }
         attr_accessor :recipient_name
@@ -317,30 +327,6 @@ module Increase
         sig { params(note: String).void }
         attr_writer :note
 
-        # The payer of the check. This will be printed on the top-left portion of the
-        # check and defaults to the return address if unspecified. This should be an array
-        # of up to 4 elements, each of which represents a line of the payer.
-        sig do
-          returns(
-            T.nilable(
-              T::Array[
-                Increase::CheckTransferCreateParams::PhysicalCheck::Payer
-              ]
-            )
-          )
-        end
-        attr_reader :payer
-
-        sig do
-          params(
-            payer:
-              T::Array[
-                Increase::CheckTransferCreateParams::PhysicalCheck::Payer::OrHash
-              ]
-          ).void
-        end
-        attr_writer :payer
-
         # The return address to be printed on the check. If omitted this will default to
         # an Increase-owned address that will mark checks as delivery failed and shred
         # them.
@@ -361,6 +347,14 @@ module Increase
         end
         attr_writer :return_address
 
+        # A custom name to print above the default return address. Cannot be provided
+        # together with `return_address`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :return_address_name
+
+        sig { params(return_address_name: String).void }
+        attr_writer :return_address_name
+
         # How to ship the check. For details on pricing, timing, and restrictions, see
         # https://increase.com/documentation/originating-checks#printing-checks .
         sig do
@@ -408,16 +402,17 @@ module Increase
             mailing_address:
               Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress::OrHash,
             memo: String,
-            recipient_name: String,
-            attachment_file_id: String,
-            check_voucher_image_file_id: String,
-            note: String,
             payer:
               T::Array[
                 Increase::CheckTransferCreateParams::PhysicalCheck::Payer::OrHash
               ],
+            recipient_name: String,
+            attachment_file_id: String,
+            check_voucher_image_file_id: String,
+            note: String,
             return_address:
               Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress::OrHash,
+            return_address_name: String,
             shipping_method:
               Increase::CheckTransferCreateParams::PhysicalCheck::ShippingMethod::OrSymbol,
             signature:
@@ -429,6 +424,10 @@ module Increase
           mailing_address:,
           # The descriptor that will be printed on the memo field on the check.
           memo:,
+          # The payer of the check. This will be printed on the top-left portion of the
+          # check. This should be an array of up to 4 elements, each of which represents a
+          # line of the payer.
+          payer:,
           # The name that will be printed on the check in the 'To:' field.
           recipient_name:,
           # The ID of a File to be attached to the check. This must have
@@ -441,14 +440,13 @@ module Increase
           check_voucher_image_file_id: nil,
           # The descriptor that will be printed on the letter included with the check.
           note: nil,
-          # The payer of the check. This will be printed on the top-left portion of the
-          # check and defaults to the return address if unspecified. This should be an array
-          # of up to 4 elements, each of which represents a line of the payer.
-          payer: nil,
           # The return address to be printed on the check. If omitted this will default to
           # an Increase-owned address that will mark checks as delivery failed and shred
           # them.
           return_address: nil,
+          # A custom name to print above the default return address. Cannot be provided
+          # together with `return_address`.
+          return_address_name: nil,
           # How to ship the check. For details on pricing, timing, and restrictions, see
           # https://increase.com/documentation/originating-checks#printing-checks .
           shipping_method: nil,
@@ -465,16 +463,17 @@ module Increase
               mailing_address:
                 Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress,
               memo: String,
-              recipient_name: String,
-              attachment_file_id: String,
-              check_voucher_image_file_id: String,
-              note: String,
               payer:
                 T::Array[
                   Increase::CheckTransferCreateParams::PhysicalCheck::Payer
                 ],
+              recipient_name: String,
+              attachment_file_id: String,
+              check_voucher_image_file_id: String,
+              note: String,
               return_address:
                 Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress,
+              return_address_name: String,
               shipping_method:
                 Increase::CheckTransferCreateParams::PhysicalCheck::ShippingMethod::OrSymbol,
               signature:

data/rbi/increase/models/entity_create_params.rbi

@@ -477,14 +477,18 @@ module Increase
           sig { returns(String) }
           attr_accessor :city
 
-          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-          sig { returns(String) }
-          attr_accessor :country
-
           # The first line of the address. This is usually the street number and street.
           sig { returns(String) }
           attr_accessor :line1
 
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+          # to `US`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :country
+
+          sig { params(country: String).void }
+          attr_writer :country
+
           # The second line of the address. This might be the floor or room number.
           sig { returns(T.nilable(String)) }
           attr_reader :line2
@@ -512,8 +516,8 @@ module Increase
           sig do
             params(
               city: String,
-              country: String,
               line1: String,
+              country: String,
               line2: String,
               state: String,
               zip: String
@@ -522,10 +526,11 @@ module Increase
           def self.new(
             # The city, district, town, or village of the address.
             city:,
-            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-            country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+            # to `US`.
+            country: nil,
             # The second line of the address. This might be the floor or room number.
             line2: nil,
             # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -540,8 +545,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                country: String,
                 line1: String,
+                country: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -754,14 +759,18 @@ module Increase
               sig { returns(String) }
               attr_accessor :city
 
-              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-              sig { returns(String) }
-              attr_accessor :country
-
               # The first line of the address. This is usually the street number and street.
               sig { returns(String) }
               attr_accessor :line1
 
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+              # to `US`.
+              sig { returns(T.nilable(String)) }
+              attr_reader :country
+
+              sig { params(country: String).void }
+              attr_writer :country
+
               # The second line of the address. This might be the floor or room number.
               sig { returns(T.nilable(String)) }
               attr_reader :line2
@@ -789,8 +798,8 @@ module Increase
               sig do
                 params(
                   city: String,
-                  country: String,
                   line1: String,
+                  country: String,
                   line2: String,
                   state: String,
                   zip: String
@@ -799,10 +808,11 @@ module Increase
               def self.new(
                 # The city, district, town, or village of the address.
                 city:,
-                # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-                country:,
                 # The first line of the address. This is usually the street number and street.
                 line1:,
+                # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+                # to `US`.
+                country: nil,
                 # The second line of the address. This might be the floor or room number.
                 line2: nil,
                 # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -817,8 +827,8 @@ module Increase
                 override.returns(
                   {
                     city: String,
-                    country: String,
                     line1: String,
+                    country: String,
                     line2: String,
                     state: String,
                     zip: String
@@ -1844,14 +1854,18 @@ module Increase
             sig { returns(String) }
             attr_accessor :city
 
-            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-            sig { returns(String) }
-            attr_accessor :country
-
             # The first line of the address. This is usually the street number and street.
             sig { returns(String) }
             attr_accessor :line1
 
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+            # to `US`.
+            sig { returns(T.nilable(String)) }
+            attr_reader :country
+
+            sig { params(country: String).void }
+            attr_writer :country
+
             # The second line of the address. This might be the floor or room number.
             sig { returns(T.nilable(String)) }
             attr_reader :line2
@@ -1879,8 +1893,8 @@ module Increase
             sig do
               params(
                 city: String,
-                country: String,
                 line1: String,
+                country: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -1889,10 +1903,11 @@ module Increase
             def self.new(
               # The city, district, town, or village of the address.
               city:,
-              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-              country:,
               # The first line of the address. This is usually the street number and street.
               line1:,
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+              # to `US`.
+              country: nil,
               # The second line of the address. This might be the floor or room number.
               line2: nil,
               # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -1907,8 +1922,8 @@ module Increase
               override.returns(
                 {
                   city: String,
-                  country: String,
                   line1: String,
+                  country: String,
                   line2: String,
                   state: String,
                   zip: String
@@ -2425,14 +2440,18 @@ module Increase
           sig { returns(String) }
           attr_accessor :city
 
-          # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-          sig { returns(String) }
-          attr_accessor :country
-
           # The first line of the address. This is usually the street number and street.
           sig { returns(String) }
           attr_accessor :line1
 
+          # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+          # to `US`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :country
+
+          sig { params(country: String).void }
+          attr_writer :country
+
           # The second line of the address. This might be the floor or room number.
           sig { returns(T.nilable(String)) }
           attr_reader :line2
@@ -2460,8 +2479,8 @@ module Increase
           sig do
             params(
               city: String,
-              country: String,
               line1: String,
+              country: String,
               line2: String,
               state: String,
               zip: String
@@ -2470,10 +2489,11 @@ module Increase
           def self.new(
             # The city, district, town, or village of the address.
             city:,
-            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-            country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+            # to `US`.
+            country: nil,
             # The second line of the address. This might be the floor or room number.
             line2: nil,
             # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -2488,8 +2508,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                country: String,
                 line1: String,
+                country: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -3618,14 +3638,18 @@ module Increase
               sig { returns(String) }
               attr_accessor :city
 
-              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-              sig { returns(String) }
-              attr_accessor :country
-
               # The first line of the address. This is usually the street number and street.
               sig { returns(String) }
               attr_accessor :line1
 
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+              # to `US`.
+              sig { returns(T.nilable(String)) }
+              attr_reader :country
+
+              sig { params(country: String).void }
+              attr_writer :country
+
               # The second line of the address. This might be the floor or room number.
               sig { returns(T.nilable(String)) }
               attr_reader :line2
@@ -3653,8 +3677,8 @@ module Increase
               sig do
                 params(
                   city: String,
-                  country: String,
                   line1: String,
+                  country: String,
                   line2: String,
                   state: String,
                   zip: String
@@ -3663,10 +3687,11 @@ module Increase
               def self.new(
                 # The city, district, town, or village of the address.
                 city:,
-                # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-                country:,
                 # The first line of the address. This is usually the street number and street.
                 line1:,
+                # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+                # to `US`.
+                country: nil,
                 # The second line of the address. This might be the floor or room number.
                 line2: nil,
                 # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -3681,8 +3706,8 @@ module Increase
                 override.returns(
                   {
                     city: String,
-                    country: String,
                     line1: String,
+                    country: String,
                     line2: String,
                     state: String,
                     zip: String
@@ -4198,14 +4223,18 @@ module Increase
             sig { returns(String) }
             attr_accessor :city
 
-            # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-            sig { returns(String) }
-            attr_accessor :country
-
             # The first line of the address. This is usually the street number and street.
             sig { returns(String) }
             attr_accessor :line1
 
+            # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+            # to `US`.
+            sig { returns(T.nilable(String)) }
+            attr_reader :country
+
+            sig { params(country: String).void }
+            attr_writer :country
+
             # The second line of the address. This might be the floor or room number.
             sig { returns(T.nilable(String)) }
             attr_reader :line2
@@ -4233,8 +4262,8 @@ module Increase
             sig do
               params(
                 city: String,
-                country: String,
                 line1: String,
+                country: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -4243,10 +4272,11 @@ module Increase
             def self.new(
               # The city, district, town, or village of the address.
               city:,
-              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-              country:,
               # The first line of the address. This is usually the street number and street.
               line1:,
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+              # to `US`.
+              country: nil,
               # The second line of the address. This might be the floor or room number.
               line2: nil,
               # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -4261,8 +4291,8 @@ module Increase
               override.returns(
                 {
                   city: String,
-                  country: String,
                   line1: String,
+                  country: String,
                   line2: String,
                   state: String,
                   zip: String