finch-api 0.1.0.pre.alpha.41 → 0.1.0.pre.alpha.43

data/lib/finch_api.rb

@@ -60,6 +60,7 @@ require_relative "finch_api/models/base_webhook_event"
 require_relative "finch_api/models/hris/benefit_contribution"
 require_relative "finch_api/models/sandbox/jobs/sandbox_job_configuration"
 require_relative "finch_api/models/access_token_create_params"
+require_relative "finch_api/models/account_disconnect_entity_params"
 require_relative "finch_api/models/account_disconnect_params"
 require_relative "finch_api/models/account_introspect_params"
 require_relative "finch_api/models/account_update_event"
@@ -71,6 +72,7 @@ require_relative "finch_api/models/connect/session_reauthenticate_response"
 require_relative "finch_api/models/connection_status_type"
 require_relative "finch_api/models/create_access_token_response"
 require_relative "finch_api/models/directory_event"
+require_relative "finch_api/models/disconnect_entity_response"
 require_relative "finch_api/models/disconnect_response"
 require_relative "finch_api/models/employment_event"
 require_relative "finch_api/models/hris/benefit_create_params"
@@ -78,6 +80,7 @@ require_relative "finch_api/models/hris/benefit_features_and_operations"
 require_relative "finch_api/models/hris/benefit_frequency"
 require_relative "finch_api/models/hris/benefit_list_params"
 require_relative "finch_api/models/hris/benefit_list_supported_benefits_params"
+require_relative "finch_api/models/hris/benefit_register_params"
 require_relative "finch_api/models/hris/benefit_retrieve_params"
 require_relative "finch_api/models/hris/benefits/enrolled_individual_benefit_response"
 require_relative "finch_api/models/hris/benefits/individual_benefit"
@@ -126,6 +129,7 @@ require_relative "finch_api/models/hris/pay_statement_data_sync_in_progress"
 require_relative "finch_api/models/hris/pay_statement_response"
 require_relative "finch_api/models/hris/pay_statement_response_body"
 require_relative "finch_api/models/hris/pay_statement_retrieve_many_params"
+require_relative "finch_api/models/hris/register_company_benefit_response"
 require_relative "finch_api/models/hris/supported_benefit"
 require_relative "finch_api/models/hris/support_per_benefit_type"
 require_relative "finch_api/models/hris/update_company_benefit_response"

data/rbi/finch_api/client.rbi

@@ -19,6 +19,9 @@ module FinchAPI
     sig { returns(T.nilable(String)) }
     attr_reader :client_secret
 
+    sig { returns(T.nilable(String)) }
+    attr_reader :webhook_secret
+
     sig { returns(FinchAPI::Resources::AccessTokens) }
     attr_reader :access_tokens
 
@@ -50,8 +53,12 @@ module FinchAPI
     attr_reader :connect
 
     # @api private
-    sig { override.returns(T::Hash[String, String]) }
-    private def auth_headers
+    sig do
+      override
+        .params(security: { bearer_auth: T::Boolean, basic_auth: T::Boolean })
+        .returns(T::Hash[String, String])
+    end
+    private def auth_headers(security:)
     end
 
     # @api private
@@ -70,6 +77,7 @@ module FinchAPI
         client_id: T.nilable(String),
         client_secret: T.nilable(String),
         access_token: T.nilable(String),
+        webhook_secret: T.nilable(String),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
@@ -83,6 +91,8 @@ module FinchAPI
       # Defaults to `ENV["FINCH_CLIENT_SECRET"]`
       client_secret: ENV["FINCH_CLIENT_SECRET"],
       access_token: nil,
+      # Defaults to `ENV["FINCH_WEBHOOK_SECRET"]`
+      webhook_secret: ENV["FINCH_WEBHOOK_SECRET"],
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["FINCH_BASE_URL"]`
       base_url: ENV["FINCH_BASE_URL"],

data/rbi/finch_api/internal/transport/base_client.rbi

@@ -51,6 +51,8 @@ module FinchAPI
                 ),
               stream: T.nilable(T::Class[T.anything]),
               model: T.nilable(FinchAPI::Internal::Type::Converter::Input),
+              security:
+                T.nilable({ bearer_auth: T::Boolean, basic_auth: T::Boolean }),
               options: T.nilable(FinchAPI::RequestOptions::OrHash)
             }
           end
@@ -228,7 +230,7 @@ module FinchAPI
         # Execute the request specified by `req`. This is the method that all resource
         # methods call into.
         #
-        # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: FinchAPI::Internal::Type::Unknown, options: {})
+        # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: FinchAPI::Internal::Type::Unknown, security: {bearer_auth: true, basic_auth: true}, options: {})
         sig do
           params(
             method: Symbol,
@@ -270,6 +272,8 @@ module FinchAPI
               ),
             stream: T.nilable(T::Class[T.anything]),
             model: T.nilable(FinchAPI::Internal::Type::Converter::Input),
+            security:
+              T.nilable({ bearer_auth: T::Boolean, basic_auth: T::Boolean }),
             options: T.nilable(FinchAPI::RequestOptions::OrHash)
           ).returns(T.anything)
         end
@@ -283,6 +287,7 @@ module FinchAPI
           page: nil,
           stream: nil,
           model: FinchAPI::Internal::Type::Unknown,
+          security: { bearer_auth: true, basic_auth: true },
           options: {}
         )
         end

data/rbi/finch_api/internal/util.rbi

@@ -148,12 +148,20 @@ module FinchAPI
         end
       end
 
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = T.let(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/, Regexp)
+
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
         def uri_origin(uri)
         end
 
+        # @api private
+        sig { params(path: T.any(String, Integer)).returns(String) }
+        def encode_path(path)
+        end
+
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
         def interpolate_path(path)
@@ -296,11 +304,31 @@ module FinchAPI
       end
 
       JSON_CONTENT =
-        T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+        T.let(%r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}, Regexp)
       JSONL_CONTENT =
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: FinchAPI::Internal::AnyHash).returns(
+            FinchAPI::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: FinchAPI::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

data/rbi/finch_api/models/account_disconnect_entity_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    class AccountDisconnectEntityParams < FinchAPI::Internal::Type::BaseModel
+      extend FinchAPI::Internal::Type::RequestParameters::Converter
+      include FinchAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            FinchAPI::AccountDisconnectEntityParams,
+            FinchAPI::Internal::AnyHash
+          )
+        end
+
+      # Array of entity UUIDs to disconnect. At least one entity ID must be provided.
+      sig { returns(T::Array[String]) }
+      attr_accessor :entity_ids
+
+      sig do
+        params(
+          entity_ids: T::Array[String],
+          request_options: FinchAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Array of entity UUIDs to disconnect. At least one entity ID must be provided.
+        entity_ids:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            entity_ids: T::Array[String],
+            request_options: FinchAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/finch_api/models/base_webhook_event.rbi

@@ -26,11 +26,19 @@ module FinchAPI
       sig { params(connection_id: String).void }
       attr_writer :connection_id
 
+      # Unique Finch id of the entity for which data has been updated.
+      sig { returns(T.nilable(String)) }
+      attr_reader :entity_id
+
+      sig { params(entity_id: String).void }
+      attr_writer :entity_id
+
       sig do
         params(
           account_id: String,
           company_id: String,
-          connection_id: String
+          connection_id: String,
+          entity_id: String
         ).returns(T.attached_class)
       end
       def self.new(
@@ -42,13 +50,20 @@ module FinchAPI
         # `connection_id` instead to identify the connection associated with this event.
         company_id:,
         # Unique Finch ID of the connection associated with the webhook event.
-        connection_id: nil
+        connection_id: nil,
+        # Unique Finch id of the entity for which data has been updated.
+        entity_id: nil
       )
       end
 
       sig do
         override.returns(
-          { account_id: String, company_id: String, connection_id: String }
+          {
+            account_id: String,
+            company_id: String,
+            connection_id: String,
+            entity_id: String
+          }
         )
       end
       def to_hash

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

@@ -23,7 +23,9 @@ module FinchAPI
         sig { returns(String) }
         attr_accessor :customer_name
 
-        # The Finch products to request access to
+        # The Finch products to request access to. Use `benefits` to access deductions
+        # endpoints — `deduction` is a deprecated alias that is still accepted but should
+        # not be combined with `benefits`.
         sig do
           returns(
             T::Array[FinchAPI::Connect::SessionNewParams::Product::OrSymbol]
@@ -96,7 +98,9 @@ module FinchAPI
           customer_id:,
           # Name of the customer
           customer_name:,
-          # The Finch products to request access to
+          # The Finch products to request access to. Use `benefits` to access deductions
+          # endpoints — `deduction` is a deprecated alias that is still accepted but should
+          # not be combined with `benefits`.
           products:,
           # Email address of the customer
           customer_email: nil,
@@ -141,7 +145,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
 
@@ -196,6 +199,11 @@ module FinchAPI
               :pay_statement,
               FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
             )
+          RECORDKEEPING =
+            T.let(
+              :recordkeeping,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
           SSN =
             T.let(
               :ssn,

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

@@ -27,7 +27,9 @@ module FinchAPI
         sig { params(minutes_to_expire: Integer).void }
         attr_writer :minutes_to_expire
 
-        # The products to request access to (optional for reauthentication)
+        # The products to request access to (optional for reauthentication). Use
+        # `benefits` to access deductions endpoints — `deduction` is a deprecated alias
+        # that is still accepted but should not be combined with `benefits`.
         sig do
           returns(
             T.nilable(
@@ -63,7 +65,9 @@ module FinchAPI
           # The number of minutes until the session expires (defaults to 43,200, which is 30
           # days)
           minutes_to_expire: nil,
-          # The products to request access to (optional for reauthentication)
+          # The products to request access to (optional for reauthentication). Use
+          # `benefits` to access deductions endpoints — `deduction` is a deprecated alias
+          # that is still accepted but should not be combined with `benefits`.
           products: nil,
           # The URI to redirect to after the Connect flow is completed
           redirect_uri: nil,
@@ -90,7 +94,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
 
@@ -148,6 +151,11 @@ module FinchAPI
               :pay_statement,
               FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
             )
+          RECORDKEEPING =
+            T.let(
+              :recordkeeping,
+              FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
+            )
           SSN =
             T.let(
               :ssn,

data/rbi/finch_api/models/create_access_token_response.rbi

@@ -73,6 +73,11 @@ module FinchAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :customer_id
 
+      # The name of your customer you provided to Finch when a connect session was
+      # created for this connection
+      sig { returns(T.nilable(String)) }
+      attr_accessor :customer_name
+
       sig do
         params(
           access_token: String,
@@ -87,7 +92,8 @@ module FinchAPI
           token_type: String,
           account_id: String,
           company_id: String,
-          customer_id: T.nilable(String)
+          customer_id: T.nilable(String),
+          customer_name: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -118,7 +124,10 @@ module FinchAPI
         company_id: nil,
         # The ID of your customer you provided to Finch when a connect session was created
         # for this connection
-        customer_id: nil
+        customer_id: nil,
+        # The name of your customer you provided to Finch when a connect session was
+        # created for this connection
+        customer_name: nil
       )
       end
 
@@ -137,7 +146,8 @@ module FinchAPI
             token_type: String,
             account_id: String,
             company_id: String,
-            customer_id: T.nilable(String)
+            customer_id: T.nilable(String),
+            customer_name: T.nilable(String)
           }
         )
       end

data/rbi/finch_api/models/disconnect_entity_response.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    class DisconnectEntityResponse < FinchAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(FinchAPI::DisconnectEntityResponse, FinchAPI::Internal::AnyHash)
+        end
+
+      # If the request is successful, Finch will return "success" (HTTP 200 status).
+      sig { returns(String) }
+      attr_accessor :status
+
+      sig { params(status: String).returns(T.attached_class) }
+      def self.new(
+        # If the request is successful, Finch will return "success" (HTTP 200 status).
+        status:
+      )
+      end
+
+      sig { override.returns({ status: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/finch_api/models/hris/benefit_contribution.rbi

@@ -9,17 +9,17 @@ module FinchAPI
         Variants =
           T.type_alias do
             T.any(
-              FinchAPI::HRIS::BenefitContribution::UnionMember0,
-              FinchAPI::HRIS::BenefitContribution::UnionMember1,
-              FinchAPI::HRIS::BenefitContribution::UnionMember2
+              FinchAPI::HRIS::BenefitContribution::BenefitContributionFixed,
+              FinchAPI::HRIS::BenefitContribution::BenefitContributionPercent,
+              FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered
             )
           end
 
-        class UnionMember0 < FinchAPI::Internal::Type::BaseModel
+        class BenefitContributionFixed < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                FinchAPI::HRIS::BenefitContribution::UnionMember0,
+                FinchAPI::HRIS::BenefitContribution::BenefitContributionFixed,
                 FinchAPI::Internal::AnyHash
               )
             end
@@ -31,7 +31,7 @@ module FinchAPI
           # Fixed contribution type.
           sig do
             returns(
-              FinchAPI::HRIS::BenefitContribution::UnionMember0::Type::OrSymbol
+              FinchAPI::HRIS::BenefitContribution::BenefitContributionFixed::Type::OrSymbol
             )
           end
           attr_accessor :type
@@ -40,7 +40,7 @@ module FinchAPI
             params(
               amount: Integer,
               type:
-                FinchAPI::HRIS::BenefitContribution::UnionMember0::Type::OrSymbol
+                FinchAPI::HRIS::BenefitContribution::BenefitContributionFixed::Type::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
@@ -56,7 +56,7 @@ module FinchAPI
               {
                 amount: Integer,
                 type:
-                  FinchAPI::HRIS::BenefitContribution::UnionMember0::Type::OrSymbol
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionFixed::Type::OrSymbol
               }
             )
           end
@@ -71,7 +71,7 @@ module FinchAPI
               T.type_alias do
                 T.all(
                   Symbol,
-                  FinchAPI::HRIS::BenefitContribution::UnionMember0::Type
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionFixed::Type
                 )
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -79,13 +79,13 @@ module FinchAPI
             FIXED =
               T.let(
                 :fixed,
-                FinchAPI::HRIS::BenefitContribution::UnionMember0::Type::TaggedSymbol
+                FinchAPI::HRIS::BenefitContribution::BenefitContributionFixed::Type::TaggedSymbol
               )
 
             sig do
               override.returns(
                 T::Array[
-                  FinchAPI::HRIS::BenefitContribution::UnionMember0::Type::TaggedSymbol
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionFixed::Type::TaggedSymbol
                 ]
               )
             end
@@ -94,11 +94,11 @@ module FinchAPI
           end
         end
 
-        class UnionMember1 < FinchAPI::Internal::Type::BaseModel
+        class BenefitContributionPercent < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                FinchAPI::HRIS::BenefitContribution::UnionMember1,
+                FinchAPI::HRIS::BenefitContribution::BenefitContributionPercent,
                 FinchAPI::Internal::AnyHash
               )
             end
@@ -110,7 +110,7 @@ module FinchAPI
           # Percentage contribution type.
           sig do
             returns(
-              FinchAPI::HRIS::BenefitContribution::UnionMember1::Type::OrSymbol
+              FinchAPI::HRIS::BenefitContribution::BenefitContributionPercent::Type::OrSymbol
             )
           end
           attr_accessor :type
@@ -119,7 +119,7 @@ module FinchAPI
             params(
               amount: Integer,
               type:
-                FinchAPI::HRIS::BenefitContribution::UnionMember1::Type::OrSymbol
+                FinchAPI::HRIS::BenefitContribution::BenefitContributionPercent::Type::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
@@ -135,7 +135,7 @@ module FinchAPI
               {
                 amount: Integer,
                 type:
-                  FinchAPI::HRIS::BenefitContribution::UnionMember1::Type::OrSymbol
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionPercent::Type::OrSymbol
               }
             )
           end
@@ -150,7 +150,7 @@ module FinchAPI
               T.type_alias do
                 T.all(
                   Symbol,
-                  FinchAPI::HRIS::BenefitContribution::UnionMember1::Type
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionPercent::Type
                 )
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -158,13 +158,13 @@ module FinchAPI
             PERCENT =
               T.let(
                 :percent,
-                FinchAPI::HRIS::BenefitContribution::UnionMember1::Type::TaggedSymbol
+                FinchAPI::HRIS::BenefitContribution::BenefitContributionPercent::Type::TaggedSymbol
               )
 
             sig do
               override.returns(
                 T::Array[
-                  FinchAPI::HRIS::BenefitContribution::UnionMember1::Type::TaggedSymbol
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionPercent::Type::TaggedSymbol
                 ]
               )
             end
@@ -173,11 +173,11 @@ module FinchAPI
           end
         end
 
-        class UnionMember2 < FinchAPI::Internal::Type::BaseModel
+        class BenefitContributionTiered < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                FinchAPI::HRIS::BenefitContribution::UnionMember2,
+                FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered,
                 FinchAPI::Internal::AnyHash
               )
             end
@@ -186,7 +186,9 @@ module FinchAPI
           # contribution thresholds.
           sig do
             returns(
-              T::Array[FinchAPI::HRIS::BenefitContribution::UnionMember2::Tier]
+              T::Array[
+                FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Tier
+              ]
             )
           end
           attr_accessor :tiers
@@ -194,7 +196,7 @@ module FinchAPI
           # Tiered contribution type (only valid for company_contribution).
           sig do
             returns(
-              FinchAPI::HRIS::BenefitContribution::UnionMember2::Type::OrSymbol
+              FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Type::OrSymbol
             )
           end
           attr_accessor :type
@@ -203,10 +205,10 @@ module FinchAPI
             params(
               tiers:
                 T::Array[
-                  FinchAPI::HRIS::BenefitContribution::UnionMember2::Tier::OrHash
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Tier::OrHash
                 ],
               type:
-                FinchAPI::HRIS::BenefitContribution::UnionMember2::Type::OrSymbol
+                FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Type::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
@@ -223,10 +225,10 @@ module FinchAPI
               {
                 tiers:
                   T::Array[
-                    FinchAPI::HRIS::BenefitContribution::UnionMember2::Tier
+                    FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Tier
                   ],
                 type:
-                  FinchAPI::HRIS::BenefitContribution::UnionMember2::Type::OrSymbol
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Type::OrSymbol
               }
             )
           end
@@ -237,7 +239,7 @@ module FinchAPI
             OrHash =
               T.type_alias do
                 T.any(
-                  FinchAPI::HRIS::BenefitContribution::UnionMember2::Tier,
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Tier,
                   FinchAPI::Internal::AnyHash
                 )
               end
@@ -269,7 +271,7 @@ module FinchAPI
               T.type_alias do
                 T.all(
                   Symbol,
-                  FinchAPI::HRIS::BenefitContribution::UnionMember2::Type
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Type
                 )
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -277,13 +279,13 @@ module FinchAPI
             TIERED =
               T.let(
                 :tiered,
-                FinchAPI::HRIS::BenefitContribution::UnionMember2::Type::TaggedSymbol
+                FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Type::TaggedSymbol
               )
 
             sig do
               override.returns(
                 T::Array[
-                  FinchAPI::HRIS::BenefitContribution::UnionMember2::Type::TaggedSymbol
+                  FinchAPI::HRIS::BenefitContribution::BenefitContributionTiered::Type::TaggedSymbol
                 ]
               )
             end