finch-api 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

data/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi

@@ -6,41 +6,36 @@ module FinchAPI
       module Benefits
         class UnenrolledIndividual < FinchAPI::BaseModel
           sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body)) }
-          def body
-          end
+          attr_reader :body
 
           sig do
-            params(_: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body)
-              .returns(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body)
-          end
-          def body=(_)
+            params(body: T.any(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, FinchAPI::Util::AnyHash))
+              .void
           end
+          attr_writer :body
 
+          # HTTP status code
           sig { returns(T.nilable(Integer)) }
-          def code
-          end
+          attr_reader :code
 
-          sig { params(_: Integer).returns(Integer) }
-          def code=(_)
-          end
+          sig { params(code: Integer).void }
+          attr_writer :code
 
           sig { returns(T.nilable(String)) }
-          def individual_id
-          end
+          attr_reader :individual_id
 
-          sig { params(_: String).returns(String) }
-          def individual_id=(_)
-          end
+          sig { params(individual_id: String).void }
+          attr_writer :individual_id
 
           sig do
             params(
-              body: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body,
+              body: T.any(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, FinchAPI::Util::AnyHash),
               code: Integer,
               individual_id: String
             )
-              .void
+              .returns(T.attached_class)
           end
-          def initialize(body: nil, code: nil, individual_id: nil)
+          def self.new(body: nil, code: nil, individual_id: nil)
           end
 
           sig do
@@ -53,34 +48,23 @@ module FinchAPI
           end
 
           class Body < FinchAPI::BaseModel
+            # A descriptive identifier for the response.
             sig { returns(T.nilable(String)) }
-            def finch_code
-            end
-
-            sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-            def finch_code=(_)
-            end
+            attr_accessor :finch_code
 
+            # Short description in English that provides more information about the response.
             sig { returns(T.nilable(String)) }
-            def message
-            end
-
-            sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-            def message=(_)
-            end
+            attr_accessor :message
 
+            # Identifier indicating whether the benefit was newly enrolled or updated.
             sig { returns(T.nilable(String)) }
-            def name
-            end
-
-            sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-            def name=(_)
-            end
+            attr_accessor :name
 
             sig do
-              params(finch_code: T.nilable(String), message: T.nilable(String), name: T.nilable(String)).void
+              params(finch_code: T.nilable(String), message: T.nilable(String), name: T.nilable(String))
+                .returns(T.attached_class)
             end
-            def initialize(finch_code: nil, message: nil, name: nil)
+            def self.new(finch_code: nil, message: nil, name: nil)
             end
 
             sig do

data/rbi/lib/finch-api/models/hris/benefits_support.rbi

@@ -5,155 +5,157 @@ module FinchAPI
     module HRIS
       class BenefitsSupport < FinchAPI::BaseModel
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def commuter
-        end
+        attr_reader :commuter
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def commuter=(_)
+          params(
+            commuter: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :commuter
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def custom_post_tax
-        end
+        attr_reader :custom_post_tax
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def custom_post_tax=(_)
+          params(
+            custom_post_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :custom_post_tax
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def custom_pre_tax
-        end
+        attr_reader :custom_pre_tax
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def custom_pre_tax=(_)
+          params(
+            custom_pre_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :custom_pre_tax
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def fsa_dependent_care
-        end
+        attr_reader :fsa_dependent_care
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def fsa_dependent_care=(_)
+          params(
+            fsa_dependent_care: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :fsa_dependent_care
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def fsa_medical
-        end
+        attr_reader :fsa_medical
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def fsa_medical=(_)
+          params(
+            fsa_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :fsa_medical
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def hsa_post
-        end
+        attr_reader :hsa_post
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def hsa_post=(_)
+          params(
+            hsa_post: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :hsa_post
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def hsa_pre
-        end
+        attr_reader :hsa_pre
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def hsa_pre=(_)
+          params(
+            hsa_pre: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :hsa_pre
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def s125_dental
-        end
+        attr_reader :s125_dental
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def s125_dental=(_)
+          params(
+            s125_dental: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :s125_dental
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def s125_medical
-        end
+        attr_reader :s125_medical
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def s125_medical=(_)
+          params(
+            s125_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :s125_medical
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def s125_vision
-        end
+        attr_reader :s125_vision
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def s125_vision=(_)
+          params(
+            s125_vision: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :s125_vision
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def simple
-        end
+        attr_reader :simple
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def simple=(_)
+          params(
+            simple: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :simple
 
         sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) }
-        def simple_ira
-        end
+        attr_reader :simple_ira
 
         sig do
-          params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-            .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations))
-        end
-        def simple_ira=(_)
+          params(
+            simple_ira: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
+          )
+            .void
         end
+        attr_writer :simple_ira
 
+        # Each benefit type and their supported features. If the benefit type is not
+        #   supported, the property will be null
         sig do
           params(
-            commuter: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            custom_post_tax: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            custom_pre_tax: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            fsa_dependent_care: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            fsa_medical: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            hsa_post: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            hsa_pre: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            s125_dental: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            s125_medical: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            s125_vision: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            simple: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations),
-            simple_ira: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)
+            commuter: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            custom_post_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            custom_pre_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            fsa_dependent_care: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            fsa_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            hsa_post: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            hsa_pre: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            s125_dental: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            s125_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            s125_vision: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            simple: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)),
+            simple_ira: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(
+        def self.new(
           commuter: nil,
           custom_post_tax: nil,
           custom_pre_tax: nil,

data/rbi/lib/finch-api/models/hris/benfit_contribution.rbi

@@ -3,7 +3,7 @@
 module FinchAPI
   module Models
     module HRIS
-      BenfitContribution = T.type_alias { FinchAPI::Models::HRIS::BenefitContribution }
+      BenfitContribution = FinchAPI::Models::HRIS::BenefitContribution
     end
   end
 end