finch-api 0.1.0.pre.alpha.30 → 0.1.0.pre.alpha.31

data/rbi/finch_api/internal/util.rbi

@@ -361,7 +361,7 @@ module FinchAPI
         # Assumes each chunk in stream has `Encoding::BINARY`.
         sig do
           params(
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             stream: T::Enumerable[String],
             suppress_error: T::Boolean
           ).returns(T.anything)

data/rbi/finch_api/models/connect/session_new_params.rbi

@@ -15,22 +15,19 @@ module FinchAPI
             )
           end
 
+        # Email address of the customer
+        sig { returns(T.nilable(String)) }
+        attr_accessor :customer_email
+
+        # Unique identifier for the customer
         sig { returns(String) }
         attr_accessor :customer_id
 
+        # Name of the customer
         sig { returns(String) }
         attr_accessor :customer_name
 
-        sig do
-          returns(
-            T::Array[FinchAPI::Connect::SessionNewParams::Product::OrSymbol]
-          )
-        end
-        attr_accessor :products
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :customer_email
-
+        # Integration configuration for the connect session
         sig do
           returns(T.nilable(FinchAPI::Connect::SessionNewParams::Integration))
         end
@@ -46,6 +43,7 @@ module FinchAPI
         end
         attr_writer :integration
 
+        # Enable manual authentication mode
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :manual
 
@@ -54,9 +52,19 @@ module FinchAPI
         sig { returns(T.nilable(Float)) }
         attr_accessor :minutes_to_expire
 
+        # The Finch products to request access to
+        sig do
+          returns(
+            T::Array[FinchAPI::Connect::SessionNewParams::Product::OrSymbol]
+          )
+        end
+        attr_accessor :products
+
+        # The URI to redirect to after the Connect flow is completed
         sig { returns(T.nilable(String)) }
         attr_accessor :redirect_uri
 
+        # Sandbox mode for testing
         sig do
           returns(
             T.nilable(FinchAPI::Connect::SessionNewParams::Sandbox::OrSymbol)
@@ -66,17 +74,17 @@ module FinchAPI
 
         sig do
           params(
+            customer_email: T.nilable(String),
             customer_id: String,
             customer_name: String,
-            products:
-              T::Array[FinchAPI::Connect::SessionNewParams::Product::OrSymbol],
-            customer_email: T.nilable(String),
             integration:
               T.nilable(
                 FinchAPI::Connect::SessionNewParams::Integration::OrHash
               ),
             manual: T.nilable(T::Boolean),
             minutes_to_expire: T.nilable(Float),
+            products:
+              T::Array[FinchAPI::Connect::SessionNewParams::Product::OrSymbol],
             redirect_uri: T.nilable(String),
             sandbox:
               T.nilable(FinchAPI::Connect::SessionNewParams::Sandbox::OrSymbol),
@@ -84,17 +92,25 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
+          # Email address of the customer
+          customer_email:,
+          # Unique identifier for the customer
           customer_id:,
+          # Name of the customer
           customer_name:,
-          products:,
-          customer_email: nil,
-          integration: nil,
-          manual: nil,
+          # Integration configuration for the connect session
+          integration:,
+          # Enable manual authentication mode
+          manual:,
           # The number of minutes until the session expires (defaults to 129,600, which is
           # 90 days)
-          minutes_to_expire: nil,
-          redirect_uri: nil,
-          sandbox: nil,
+          minutes_to_expire:,
+          # The Finch products to request access to
+          products:,
+          # The URI to redirect to after the Connect flow is completed
+          redirect_uri:,
+          # Sandbox mode for testing
+          sandbox:,
           request_options: {}
         )
         end
@@ -102,17 +118,17 @@ module FinchAPI
         sig do
           override.returns(
             {
+              customer_email: T.nilable(String),
               customer_id: String,
               customer_name: String,
-              products:
-                T::Array[
-                  FinchAPI::Connect::SessionNewParams::Product::OrSymbol
-                ],
-              customer_email: T.nilable(String),
               integration:
                 T.nilable(FinchAPI::Connect::SessionNewParams::Integration),
               manual: T.nilable(T::Boolean),
               minutes_to_expire: T.nilable(Float),
+              products:
+                T::Array[
+                  FinchAPI::Connect::SessionNewParams::Product::OrSymbol
+                ],
               redirect_uri: T.nilable(String),
               sandbox:
                 T.nilable(
@@ -125,78 +141,6 @@ module FinchAPI
         def to_hash
         end
 
-        # The Finch products that can be requested during the Connect flow.
-        module Product
-          extend FinchAPI::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, FinchAPI::Connect::SessionNewParams::Product)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          COMPANY =
-            T.let(
-              :company,
-              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-            )
-          DIRECTORY =
-            T.let(
-              :directory,
-              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-            )
-          INDIVIDUAL =
-            T.let(
-              :individual,
-              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-            )
-          EMPLOYMENT =
-            T.let(
-              :employment,
-              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-            )
-          PAYMENT =
-            T.let(
-              :payment,
-              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-            )
-          PAY_STATEMENT =
-            T.let(
-              :pay_statement,
-              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-            )
-          BENEFITS =
-            T.let(
-              :benefits,
-              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-            )
-          SSN =
-            T.let(
-              :ssn,
-              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-            )
-          DEDUCTION =
-            T.let(
-              :deduction,
-              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-            )
-          DOCUMENTS =
-            T.let(
-              :documents,
-              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
         class Integration < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -206,6 +150,7 @@ module FinchAPI
               )
             end
 
+          # The authentication method to use
           sig do
             returns(
               T.nilable(
@@ -215,9 +160,11 @@ module FinchAPI
           end
           attr_accessor :auth_method
 
+          # The provider to integrate with
           sig { returns(T.nilable(String)) }
           attr_accessor :provider
 
+          # Integration configuration for the connect session
           sig do
             params(
               auth_method:
@@ -227,7 +174,12 @@ module FinchAPI
               provider: T.nilable(String)
             ).returns(T.attached_class)
           end
-          def self.new(auth_method: nil, provider: nil)
+          def self.new(
+            # The authentication method to use
+            auth_method:,
+            # The provider to integrate with
+            provider:
+          )
           end
 
           sig do
@@ -244,6 +196,7 @@ module FinchAPI
           def to_hash
           end
 
+          # The authentication method to use
           module AuthMethod
             extend FinchAPI::Internal::Type::Enum
 
@@ -289,6 +242,79 @@ module FinchAPI
           end
         end
 
+        # The Finch products that can be requested during the Connect flow.
+        module Product
+          extend FinchAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, FinchAPI::Connect::SessionNewParams::Product)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BENEFITS =
+            T.let(
+              :benefits,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          COMPANY =
+            T.let(
+              :company,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          DEDUCTION =
+            T.let(
+              :deduction,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          DIRECTORY =
+            T.let(
+              :directory,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          DOCUMENTS =
+            T.let(
+              :documents,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          EMPLOYMENT =
+            T.let(
+              :employment,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          INDIVIDUAL =
+            T.let(
+              :individual,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          PAYMENT =
+            T.let(
+              :payment,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          PAY_STATEMENT =
+            T.let(
+              :pay_statement,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          SSN =
+            T.let(
+              :ssn,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Sandbox mode for testing
         module Sandbox
           extend FinchAPI::Internal::Type::Enum
 

data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi

@@ -21,7 +21,7 @@ module FinchAPI
 
         # The number of minutes until the session expires (defaults to 43,200, which is 30
         # days)
-        sig { returns(T.nilable(Integer)) }
+        sig { returns(Integer) }
         attr_accessor :minutes_to_expire
 
         # The products to request access to (optional for reauthentication)
@@ -43,7 +43,7 @@ module FinchAPI
         sig do
           params(
             connection_id: String,
-            minutes_to_expire: T.nilable(Integer),
+            minutes_to_expire: Integer,
             products:
               T.nilable(
                 T::Array[
@@ -59,11 +59,11 @@ module FinchAPI
           connection_id:,
           # The number of minutes until the session expires (defaults to 43,200, which is 30
           # days)
-          minutes_to_expire: nil,
+          minutes_to_expire:,
           # The products to request access to (optional for reauthentication)
-          products: nil,
+          products:,
           # The URI to redirect to after the Connect flow is completed
-          redirect_uri: nil,
+          redirect_uri:,
           request_options: {}
         )
         end
@@ -72,7 +72,7 @@ module FinchAPI
           override.returns(
             {
               connection_id: String,
-              minutes_to_expire: T.nilable(Integer),
+              minutes_to_expire: Integer,
               products:
                 T.nilable(
                   T::Array[
@@ -100,19 +100,29 @@ module FinchAPI
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+          BENEFITS =
+            T.let(
+              :benefits,
+              FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
+            )
           COMPANY =
             T.let(
               :company,
               FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
             )
+          DEDUCTION =
+            T.let(
+              :deduction,
+              FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
+            )
           DIRECTORY =
             T.let(
               :directory,
               FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
             )
-          INDIVIDUAL =
+          DOCUMENTS =
             T.let(
-              :individual,
+              :documents,
               FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
             )
           EMPLOYMENT =
@@ -120,6 +130,11 @@ module FinchAPI
               :employment,
               FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
             )
+          INDIVIDUAL =
+            T.let(
+              :individual,
+              FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
+            )
           PAYMENT =
             T.let(
               :payment,
@@ -130,26 +145,11 @@ module FinchAPI
               :pay_statement,
               FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
             )
-          BENEFITS =
-            T.let(
-              :benefits,
-              FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
-            )
           SSN =
             T.let(
               :ssn,
               FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
             )
-          DEDUCTION =
-            T.let(
-              :deduction,
-              FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
-            )
-          DOCUMENTS =
-            T.let(
-              :documents,
-              FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
-            )
 
           sig do
             override.returns(

data/rbi/finch_api/models/create_access_token_response.rbi

@@ -36,6 +36,10 @@ module FinchAPI
       end
       attr_accessor :connection_type
 
+      # An array of entity IDs that can be accessed with this access token
+      sig { returns(T::Array[String]) }
+      attr_accessor :entity_ids
+
       # An array of the authorized products associated with the `access_token`
       sig { returns(T::Array[String]) }
       attr_accessor :products
@@ -77,6 +81,7 @@ module FinchAPI
           connection_id: String,
           connection_type:
             FinchAPI::CreateAccessTokenResponse::ConnectionType::OrSymbol,
+          entity_ids: T::Array[String],
           products: T::Array[String],
           provider_id: String,
           token_type: String,
@@ -97,6 +102,8 @@ module FinchAPI
         # - `provider` - connection to an external provider
         # - `finch` - finch-generated data.
         connection_type:,
+        # An array of entity IDs that can be accessed with this access token
+        entity_ids:,
         # An array of the authorized products associated with the `access_token`
         products:,
         # The ID of the provider associated with the `access_token`
@@ -124,6 +131,7 @@ module FinchAPI
             connection_id: String,
             connection_type:
               FinchAPI::CreateAccessTokenResponse::ConnectionType::TaggedSymbol,
+            entity_ids: T::Array[String],
             products: T::Array[String],
             provider_id: String,
             token_type: String,