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

data/rbi/finch_api/models/sandbox/employment_update_params.rbi

@@ -15,6 +15,9 @@ module FinchAPI
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :individual_id
+
         # Worker's compensation classification code for this employee
         sig { returns(T.nilable(String)) }
         attr_accessor :class_code
@@ -84,6 +87,17 @@ module FinchAPI
         sig { returns(T.nilable(String)) }
         attr_accessor :first_name
 
+        # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+        # `unknown`.
+        sig do
+          returns(
+            T.nilable(
+              FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus::OrSymbol
+            )
+          )
+        end
+        attr_accessor :flsa_status
+
         # The employee's income as reported by the provider. This may not always be
         # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
         # depending on what information the provider returns.
@@ -147,6 +161,7 @@ module FinchAPI
 
         sig do
           params(
+            individual_id: String,
             class_code: T.nilable(String),
             custom_fields:
               T.nilable(
@@ -168,6 +183,10 @@ module FinchAPI
               ),
             end_date: T.nilable(String),
             first_name: T.nilable(String),
+            flsa_status:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus::OrSymbol
+              ),
             income: T.nilable(FinchAPI::Income::OrHash),
             income_history:
               T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]),
@@ -187,6 +206,7 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
+          individual_id:,
           # Worker's compensation classification code for this employee
           class_code: nil,
           # Custom fields for the individual. These are fields which are defined by the
@@ -202,6 +222,9 @@ module FinchAPI
           end_date: nil,
           # The legal first name of the individual.
           first_name: nil,
+          # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+          # `unknown`.
+          flsa_status: nil,
           # The employee's income as reported by the provider. This may not always be
           # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
           # depending on what information the provider returns.
@@ -230,6 +253,7 @@ module FinchAPI
         sig do
           override.returns(
             {
+              individual_id: String,
               class_code: T.nilable(String),
               custom_fields:
                 T.nilable(
@@ -251,6 +275,10 @@ module FinchAPI
                 ),
               end_date: T.nilable(String),
               first_name: T.nilable(String),
+              flsa_status:
+                T.nilable(
+                  FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus::OrSymbol
+                ),
               income: T.nilable(FinchAPI::Income),
               income_history: T.nilable(T::Array[T.nilable(FinchAPI::Income)]),
               is_active: T.nilable(T::Boolean),
@@ -282,25 +310,75 @@ module FinchAPI
           sig { returns(T.nilable(String)) }
           attr_accessor :name
 
-          sig { returns(T.nilable(T.anything)) }
-          attr_reader :value
-
-          sig { params(value: T.anything).void }
-          attr_writer :value
-
           sig do
-            params(name: T.nilable(String), value: T.anything).returns(
-              T.attached_class
+            returns(
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::Value::Variants
+              )
             )
           end
+          attr_accessor :value
+
+          sig do
+            params(
+              name: T.nilable(String),
+              value:
+                T.nilable(
+                  FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::Value::Variants
+                )
+            ).returns(T.attached_class)
+          end
           def self.new(name: nil, value: nil)
           end
 
           sig do
-            override.returns({ name: T.nilable(String), value: T.anything })
+            override.returns(
+              {
+                name: T.nilable(String),
+                value:
+                  T.nilable(
+                    FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::Value::Variants
+                  )
+              }
+            )
           end
           def to_hash
           end
+
+          module Value
+            extend FinchAPI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.nilable(
+                  T.any(
+                    String,
+                    T::Array[T.anything],
+                    T.anything,
+                    Float,
+                    T::Boolean
+                  )
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::Value::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+
+            UnionMember1Array =
+              T.let(
+                FinchAPI::Internal::Type::ArrayOf[
+                  FinchAPI::Internal::Type::Unknown
+                ],
+                FinchAPI::Internal::Type::Converter
+              )
+          end
         end
 
         class Department < FinchAPI::Internal::Type::BaseModel
@@ -550,6 +628,47 @@ module FinchAPI
           end
         end
 
+        # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+        # `unknown`.
+        module FlsaStatus
+          extend FinchAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EXEMPT =
+            T.let(
+              :exempt,
+              FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus::TaggedSymbol
+            )
+          NON_EXEMPT =
+            T.let(
+              :non_exempt,
+              FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus::TaggedSymbol
+            )
+          UNKNOWN =
+            T.let(
+              :unknown,
+              FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class Manager < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/finch_api/models/sandbox/employment_update_response.rbi

@@ -94,6 +94,17 @@ module FinchAPI
         sig { returns(T.nilable(String)) }
         attr_accessor :first_name
 
+        # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+        # `unknown`.
+        sig do
+          returns(
+            T.nilable(
+              FinchAPI::Models::Sandbox::EmploymentUpdateResponse::FlsaStatus::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :flsa_status
+
         # The employee's income as reported by the provider. This may not always be
         # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
         # depending on what information the provider returns.
@@ -183,6 +194,10 @@ module FinchAPI
               ),
             end_date: T.nilable(String),
             first_name: T.nilable(String),
+            flsa_status:
+              T.nilable(
+                FinchAPI::Models::Sandbox::EmploymentUpdateResponse::FlsaStatus::OrSymbol
+              ),
             income: T.nilable(FinchAPI::Income::OrHash),
             income_history:
               T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]),
@@ -218,6 +233,9 @@ module FinchAPI
           end_date: nil,
           # The legal first name of the individual.
           first_name: nil,
+          # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+          # `unknown`.
+          flsa_status: nil,
           # The employee's income as reported by the provider. This may not always be
           # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
           # depending on what information the provider returns.
@@ -267,6 +285,10 @@ module FinchAPI
                 ),
               end_date: T.nilable(String),
               first_name: T.nilable(String),
+              flsa_status:
+                T.nilable(
+                  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::FlsaStatus::TaggedSymbol
+                ),
               income: T.nilable(FinchAPI::Income),
               income_history: T.nilable(T::Array[T.nilable(FinchAPI::Income)]),
               is_active: T.nilable(T::Boolean),
@@ -299,25 +321,75 @@ module FinchAPI
           sig { returns(T.nilable(String)) }
           attr_accessor :name
 
-          sig { returns(T.nilable(T.anything)) }
-          attr_reader :value
-
-          sig { params(value: T.anything).void }
-          attr_writer :value
-
           sig do
-            params(name: T.nilable(String), value: T.anything).returns(
-              T.attached_class
+            returns(
+              T.nilable(
+                FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::Value::Variants
+              )
             )
           end
+          attr_accessor :value
+
+          sig do
+            params(
+              name: T.nilable(String),
+              value:
+                T.nilable(
+                  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::Value::Variants
+                )
+            ).returns(T.attached_class)
+          end
           def self.new(name: nil, value: nil)
           end
 
           sig do
-            override.returns({ name: T.nilable(String), value: T.anything })
+            override.returns(
+              {
+                name: T.nilable(String),
+                value:
+                  T.nilable(
+                    FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::Value::Variants
+                  )
+              }
+            )
           end
           def to_hash
           end
+
+          module Value
+            extend FinchAPI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.nilable(
+                  T.any(
+                    String,
+                    T::Array[T.anything],
+                    T.anything,
+                    Float,
+                    T::Boolean
+                  )
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField::Value::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+
+            UnionMember1Array =
+              T.let(
+                FinchAPI::Internal::Type::ArrayOf[
+                  FinchAPI::Internal::Type::Unknown
+                ],
+                FinchAPI::Internal::Type::Converter
+              )
+          end
         end
 
         class Department < FinchAPI::Internal::Type::BaseModel
@@ -567,6 +639,47 @@ module FinchAPI
           end
         end
 
+        # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+        # `unknown`.
+        module FlsaStatus
+          extend FinchAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                FinchAPI::Models::Sandbox::EmploymentUpdateResponse::FlsaStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EXEMPT =
+            T.let(
+              :exempt,
+              FinchAPI::Models::Sandbox::EmploymentUpdateResponse::FlsaStatus::TaggedSymbol
+            )
+          NON_EXEMPT =
+            T.let(
+              :non_exempt,
+              FinchAPI::Models::Sandbox::EmploymentUpdateResponse::FlsaStatus::TaggedSymbol
+            )
+          UNKNOWN =
+            T.let(
+              :unknown,
+              FinchAPI::Models::Sandbox::EmploymentUpdateResponse::FlsaStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                FinchAPI::Models::Sandbox::EmploymentUpdateResponse::FlsaStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class Manager < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/finch_api/models/sandbox/individual_update_params.rbi

@@ -15,6 +15,9 @@ module FinchAPI
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :individual_id
+
         sig { returns(T.nilable(String)) }
         attr_accessor :dob
 
@@ -97,6 +100,7 @@ module FinchAPI
 
         sig do
           params(
+            individual_id: String,
             dob: T.nilable(String),
             emails:
               T.nilable(
@@ -131,6 +135,7 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
+          individual_id:,
           dob: nil,
           emails: nil,
           # Social Security Number of the individual in **encrypted** format. This field is
@@ -163,6 +168,7 @@ module FinchAPI
         sig do
           override.returns(
             {
+              individual_id: String,
               dob: T.nilable(String),
               emails:
                 T.nilable(

data/rbi/finch_api/models.rbi

@@ -3,6 +3,9 @@
 module FinchAPI
   AccessTokenCreateParams = FinchAPI::Models::AccessTokenCreateParams
 
+  AccountDisconnectEntityParams =
+    FinchAPI::Models::AccountDisconnectEntityParams
+
   AccountDisconnectParams = FinchAPI::Models::AccountDisconnectParams
 
   AccountIntrospectParams = FinchAPI::Models::AccountIntrospectParams
@@ -21,6 +24,8 @@ module FinchAPI
 
   DirectoryEvent = FinchAPI::Models::DirectoryEvent
 
+  DisconnectEntityResponse = FinchAPI::Models::DisconnectEntityResponse
+
   DisconnectResponse = FinchAPI::Models::DisconnectResponse
 
   EmploymentEvent = FinchAPI::Models::EmploymentEvent

data/rbi/finch_api/resources/account.rbi

@@ -12,6 +12,21 @@ module FinchAPI
       def disconnect(request_options: {})
       end
 
+      # Disconnect entity(s) from a connection without affecting other entities
+      # associated with the same connection.
+      sig do
+        params(
+          entity_ids: T::Array[String],
+          request_options: FinchAPI::RequestOptions::OrHash
+        ).returns(FinchAPI::DisconnectEntityResponse)
+      end
+      def disconnect_entity(
+        # Array of entity UUIDs to disconnect. At least one entity ID must be provided.
+        entity_ids:,
+        request_options: {}
+      )
+      end
+
       # Read account information associated with an `access_token`
       sig do
         params(request_options: FinchAPI::RequestOptions::OrHash).returns(

data/rbi/finch_api/resources/connect/sessions.rbi

@@ -29,7 +29,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,
@@ -69,7 +71,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,

data/rbi/finch_api/resources/hris/benefits.rbi

@@ -107,6 +107,30 @@ module FinchAPI
         )
         end
 
+        # Register existing benefits from the customer on the provider, on Finch's end.
+        # Please use the `/provider` endpoint to view available types for each provider.
+        sig do
+          params(
+            entity_ids: T::Array[String],
+            description: String,
+            frequency: T.nilable(FinchAPI::HRIS::BenefitFrequency::OrSymbol),
+            type: T.nilable(FinchAPI::HRIS::BenefitType::OrSymbol),
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(FinchAPI::HRIS::RegisterCompanyBenefitResponse)
+        end
+        def register(
+          # Query param: The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          # Body param
+          description: nil,
+          # Body param: The frequency of the benefit deduction/contribution.
+          frequency: nil,
+          # Body param: Type of benefit.
+          type: nil,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: FinchAPI::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/finch_api/resources/jobs/automated.rbi

@@ -20,17 +20,15 @@ module FinchAPI
         # access to this endpoint, please contact your Finch account manager.
         sig do
           params(
-            type: FinchAPI::Jobs::AutomatedCreateParams::Type::OrSymbol,
-            params: FinchAPI::Jobs::AutomatedCreateParams::Params::OrHash,
+            body:
+              T.any(
+                FinchAPI::Jobs::AutomatedCreateParams::Body::DataSyncAll::OrHash,
+                FinchAPI::Jobs::AutomatedCreateParams::Body::W4FormEmployeeSync::OrHash
+              ),
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Models::Jobs::AutomatedCreateResponse)
         end
-        def create(
-          # The type of job to start.
-          type:,
-          params:,
-          request_options: {}
-        )
+        def create(body:, request_options: {})
         end
 
         # Get an automated job by `job_id`.

data/rbi/finch_api/resources/sandbox/employment.rbi

@@ -29,6 +29,10 @@ module FinchAPI
               ),
             end_date: T.nilable(String),
             first_name: T.nilable(String),
+            flsa_status:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus::OrSymbol
+              ),
             income: T.nilable(FinchAPI::Income::OrHash),
             income_history:
               T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]),
@@ -64,6 +68,9 @@ module FinchAPI
           end_date: nil,
           # The legal first name of the individual.
           first_name: nil,
+          # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+          # `unknown`.
+          flsa_status: nil,
           # The employee's income as reported by the provider. This may not always be
           # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
           # depending on what information the provider returns.

data/sig/finch_api/client.rbs

@@ -14,6 +14,8 @@ module FinchAPI
 
     attr_reader client_secret: String?
 
+    attr_reader webhook_secret: String?
+
     attr_reader access_tokens: FinchAPI::Resources::AccessTokens
 
     attr_reader hris: FinchAPI::Resources::HRIS
@@ -34,7 +36,9 @@ module FinchAPI
 
     attr_reader connect: FinchAPI::Resources::Connect
 
-    private def auth_headers: -> ::Hash[String, String]
+    private def auth_headers: (
+      security: { bearer_auth: bool, basic_auth: bool }
+    ) -> ::Hash[String, String]
 
     private def bearer_auth: -> ::Hash[String, String]
 
@@ -44,6 +48,7 @@ module FinchAPI
       ?client_id: String?,
       ?client_secret: String?,
       ?access_token: String?,
+      ?webhook_secret: String?,
       ?base_url: String?,
       ?max_retries: Integer,
       ?timeout: Float,

data/sig/finch_api/internal/transport/base_client.rbs

@@ -20,6 +20,7 @@ module FinchAPI
             page: Class?,
             stream: Class?,
             model: FinchAPI::Internal::Type::Converter::input?,
+            security: { bearer_auth: bool, basic_auth: bool }?,
             options: FinchAPI::request_opts?
           }
         type request_input =
@@ -123,6 +124,7 @@ module FinchAPI
           ?page: Class?,
           ?stream: Class?,
           ?model: FinchAPI::Internal::Type::Converter::input?,
+          ?security: { bearer_auth: bool, basic_auth: bool }?,
           ?options: FinchAPI::request_opts?
         ) -> top
 

data/sig/finch_api/internal/util.rbs

@@ -45,8 +45,12 @@ module FinchAPI
         -> top?
       } -> top?
 
+      RFC_3986_NOT_PCHARS: Regexp
+
       def self?.uri_origin: (URI::Generic uri) -> String
 
+      def self?.encode_path: (String | Integer path) -> String
+
       def self?.interpolate_path: (String | ::Array[String] path) -> String
 
       def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]
@@ -106,6 +110,16 @@ module FinchAPI
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/finch_api/models/account_disconnect_entity_params.rbs

@@ -0,0 +1,24 @@
+module FinchAPI
+  module Models
+    type account_disconnect_entity_params =
+      { entity_ids: ::Array[String] }
+      & FinchAPI::Internal::Type::request_parameters
+
+    class AccountDisconnectEntityParams < FinchAPI::Internal::Type::BaseModel
+      extend FinchAPI::Internal::Type::RequestParameters::Converter
+      include FinchAPI::Internal::Type::RequestParameters
+
+      attr_accessor entity_ids: ::Array[String]
+
+      def initialize: (
+        entity_ids: ::Array[String],
+        ?request_options: FinchAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        entity_ids: ::Array[String],
+        request_options: FinchAPI::RequestOptions
+      }
+    end
+  end
+end