increase 1.342.0 → 1.344.0

data/lib/increase/models/file_contents_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Files#contents
+    class FileContentsParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute file_id
+      #   The identifier of the File.
+      #
+      #   @return [String]
+      required :file_id, String
+
+      # @!method initialize(file_id:, request_options: {})
+      #   @param file_id [String] The identifier of the File.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/unwrap_webhook_event.rb

@@ -354,6 +354,12 @@ module Increase
         # Occurs whenever a Physical Check is updated.
         PHYSICAL_CHECK_UPDATED = :"physical_check.updated"
 
+        # Occurs whenever a Physical Check Book is created.
+        PHYSICAL_CHECK_BOOK_CREATED = :"physical_check_book.created"
+
+        # Occurs whenever a Physical Check Book is updated.
+        PHYSICAL_CHECK_BOOK_UPDATED = :"physical_check_book.updated"
+
         # Occurs whenever a Program is created.
         PROGRAM_CREATED = :"program.created"
 

data/lib/increase/models.rb

@@ -309,6 +309,8 @@ module Increase
 
   File = Increase::Models::File
 
+  FileContentsParams = Increase::Models::FileContentsParams
+
   FileCreateParams = Increase::Models::FileCreateParams
 
   FileLink = Increase::Models::FileLink

data/lib/increase/resources/files.rb

@@ -94,6 +94,34 @@ module Increase
         )
       end
 
+      # Download the contents of a File. Responds with a 307 redirect whose `Location`
+      # header points at a short-lived, pre-signed URL. Our
+      # [SDKs](/documentation/software-development-kits) follow the redirect and return
+      # the File's contents; if you call the API directly, follow the redirect to
+      # download it. The pre-signed URL serves the File with a `Content-Type` matching
+      # its `mime` and a `Content-Disposition` header set to its `filename`. It expires
+      # in 10 minutes. To share a File with someone who doesn't have access to your API
+      # key, create a File Link.
+      #
+      # @overload contents(file_id, request_options: {})
+      #
+      # @param file_id [String] The identifier of the File.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [StringIO]
+      #
+      # @see Increase::Models::FileContentsParams
+      def contents(file_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["files/%1$s/contents", file_id],
+          headers: {"accept" => "application/octet-stream"},
+          model: StringIO,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Increase::Client]

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.342.0"
+  VERSION = "1.344.0"
 end

data/lib/increase.rb

@@ -189,6 +189,7 @@ require_relative "increase/models/fednow_transfer_create_params"
 require_relative "increase/models/fednow_transfer_list_params"
 require_relative "increase/models/fednow_transfer_retrieve_params"
 require_relative "increase/models/file"
+require_relative "increase/models/file_contents_params"
 require_relative "increase/models/file_create_params"
 require_relative "increase/models/file_link"
 require_relative "increase/models/file_link_create_params"

data/rbi/increase/internal/transport/base_client.rbi

@@ -70,8 +70,6 @@ module Increase
         # from whatwg fetch spec
         MAX_REDIRECTS = 20
 
-        PLATFORM_HEADERS = T::Hash[String, String]
-
         class << self
           # @api private
           sig do
@@ -213,16 +211,10 @@ module Increase
           params(
             request: Increase::Internal::Transport::BaseClient::RequestInput,
             redirect_count: Integer,
-            retry_count: Integer,
-            send_retry_header: T::Boolean
+            retry_count: Integer
           ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
         end
-        def send_request(
-          request,
-          redirect_count:,
-          retry_count:,
-          send_retry_header:
-        )
+        def send_request(request, redirect_count:, retry_count:)
         end
 
         # Execute the request specified by `req`. This is the method that all resource

data/rbi/increase/models/beneficial_owner_create_params.rbi

@@ -205,18 +205,14 @@ 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
@@ -244,8 +240,8 @@ module Increase
           sig do
             params(
               city: String,
-              line1: String,
               country: String,
+              line1: String,
               line2: String,
               state: String,
               zip: String
@@ -254,11 +250,10 @@ 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
@@ -273,8 +268,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                line1: String,
                 country: String,
+                line1: String,
                 line2: String,
                 state: String,
                 zip: String

data/rbi/increase/models/beneficial_owner_update_params.rbi

@@ -152,18 +152,14 @@ 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
@@ -191,8 +187,8 @@ module Increase
         sig do
           params(
             city: String,
-            line1: String,
             country: String,
+            line1: String,
             line2: String,
             state: String,
             zip: String
@@ -201,11 +197,10 @@ 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
@@ -220,8 +215,8 @@ module Increase
           override.returns(
             {
               city: String,
-              line1: String,
               country: String,
+              line1: String,
               line2: String,
               state: String,
               zip: String

data/rbi/increase/models/entity_create_params.rbi

@@ -477,18 +477,14 @@ 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
@@ -516,8 +512,8 @@ module Increase
           sig do
             params(
               city: String,
-              line1: String,
               country: String,
+              line1: String,
               line2: String,
               state: String,
               zip: String
@@ -526,11 +522,10 @@ 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
@@ -545,8 +540,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                line1: String,
                 country: String,
+                line1: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -759,18 +754,14 @@ 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
@@ -798,8 +789,8 @@ module Increase
               sig do
                 params(
                   city: String,
-                  line1: String,
                   country: String,
+                  line1: String,
                   line2: String,
                   state: String,
                   zip: String
@@ -808,11 +799,10 @@ 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
@@ -827,8 +817,8 @@ module Increase
                 override.returns(
                   {
                     city: String,
-                    line1: String,
                     country: String,
+                    line1: String,
                     line2: String,
                     state: String,
                     zip: String
@@ -1854,18 +1844,14 @@ 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
@@ -1893,8 +1879,8 @@ module Increase
             sig do
               params(
                 city: String,
-                line1: String,
                 country: String,
+                line1: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -1903,11 +1889,10 @@ 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
@@ -1922,8 +1907,8 @@ module Increase
               override.returns(
                 {
                   city: String,
-                  line1: String,
                   country: String,
+                  line1: String,
                   line2: String,
                   state: String,
                   zip: String
@@ -2440,18 +2425,14 @@ 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
@@ -2479,8 +2460,8 @@ module Increase
           sig do
             params(
               city: String,
-              line1: String,
               country: String,
+              line1: String,
               line2: String,
               state: String,
               zip: String
@@ -2489,11 +2470,10 @@ 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
@@ -2508,8 +2488,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                line1: String,
                 country: String,
+                line1: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -3638,18 +3618,14 @@ 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
@@ -3677,8 +3653,8 @@ module Increase
               sig do
                 params(
                   city: String,
-                  line1: String,
                   country: String,
+                  line1: String,
                   line2: String,
                   state: String,
                   zip: String
@@ -3687,11 +3663,10 @@ 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
@@ -3706,8 +3681,8 @@ module Increase
                 override.returns(
                   {
                     city: String,
-                    line1: String,
                     country: String,
+                    line1: String,
                     line2: String,
                     state: String,
                     zip: String
@@ -4223,18 +4198,14 @@ 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
@@ -4262,8 +4233,8 @@ module Increase
             sig do
               params(
                 city: String,
-                line1: String,
                 country: String,
+                line1: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -4272,11 +4243,10 @@ 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
@@ -4291,8 +4261,8 @@ module Increase
               override.returns(
                 {
                   city: String,
-                  line1: String,
                   country: String,
+                  line1: String,
                   line2: String,
                   state: String,
                   zip: String

data/rbi/increase/models/entity_update_params.rbi

@@ -341,18 +341,14 @@ 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
@@ -380,8 +376,8 @@ module Increase
           sig do
             params(
               city: String,
-              line1: String,
               country: String,
+              line1: String,
               line2: String,
               state: String,
               zip: String
@@ -390,11 +386,10 @@ 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
@@ -409,8 +404,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                line1: String,
                 country: String,
+                line1: String,
                 line2: String,
                 state: String,
                 zip: String
@@ -779,18 +774,14 @@ 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
@@ -818,8 +809,8 @@ module Increase
           sig do
             params(
               city: String,
-              line1: String,
               country: String,
+              line1: String,
               line2: String,
               state: String,
               zip: String
@@ -828,11 +819,10 @@ 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
@@ -847,8 +837,8 @@ module Increase
             override.returns(
               {
                 city: String,
-                line1: String,
                 country: String,
+                line1: String,
                 line2: String,
                 state: String,
                 zip: String