finch-api 0.1.0.pre.alpha.1

data/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs

@@ -0,0 +1,25 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        type individual_enrolled_ids_response =
+          { benefit_id: String, individual_ids: ::Array[String] }
+
+        class IndividualEnrolledIDsResponse < FinchAPI::BaseModel
+          attr_accessor benefit_id: String
+
+          attr_accessor individual_ids: ::Array[String]
+
+          def initialize:
+            (benefit_id: String, individual_ids: ::Array[String]) -> void
+            | (
+              ?FinchAPI::Models::HRIS::Benefits::individual_enrolled_ids_response
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_enrolled_ids_response
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs

@@ -0,0 +1,31 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        type individual_retrieve_many_benefits_params =
+          { individual_ids: String } & FinchAPI::request_parameters
+
+        class IndividualRetrieveManyBenefitsParams < FinchAPI::BaseModel
+          extend FinchAPI::RequestParameters::Converter
+          include FinchAPI::RequestParameters
+
+          attr_reader individual_ids: String?
+
+          def individual_ids=: (String) -> String
+
+          def initialize:
+            (
+              individual_ids: String,
+              request_options: FinchAPI::request_opts
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::Benefits::individual_retrieve_many_benefits_params
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_retrieve_many_benefits_params
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs

@@ -0,0 +1,31 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        type individual_unenroll_many_params =
+          { individual_ids: ::Array[String] } & FinchAPI::request_parameters
+
+        class IndividualUnenrollManyParams < FinchAPI::BaseModel
+          extend FinchAPI::RequestParameters::Converter
+          include FinchAPI::RequestParameters
+
+          attr_reader individual_ids: ::Array[String]?
+
+          def individual_ids=: (::Array[String]) -> ::Array[String]
+
+          def initialize:
+            (
+              individual_ids: ::Array[String],
+              request_options: FinchAPI::request_opts
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::Benefits::individual_unenroll_many_params
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_unenroll_many_params
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs

@@ -0,0 +1,62 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module Benefits
+        type unenrolled_individual =
+          {
+            body: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body,
+            code: Integer,
+            individual_id: String
+          }
+
+        class UnenrolledIndividual < FinchAPI::BaseModel
+          attr_reader body: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body?
+
+          def body=: (
+            FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body
+          ) -> FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body
+
+          attr_reader code: Integer?
+
+          def code=: (Integer) -> Integer
+
+          attr_reader individual_id: String?
+
+          def individual_id=: (String) -> String
+
+          def initialize:
+            (
+              body: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body,
+              code: Integer,
+              individual_id: String
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::Benefits::unenrolled_individual
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::Benefits::unenrolled_individual
+
+          type body = { finch_code: String?, message: String?, name: String? }
+
+          class Body < FinchAPI::BaseModel
+            attr_accessor finch_code: String?
+
+            attr_accessor message: String?
+
+            attr_accessor name: String?
+
+            def initialize:
+              (finch_code: String?, message: String?, name: String?) -> void
+              | (
+                ?FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::body
+                | FinchAPI::BaseModel data
+              ) -> void
+
+            def to_hash: -> FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::body
+          end
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/benefits_support.rbs

@@ -0,0 +1,68 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type benefits_support =
+        {
+          commuter: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          custom_post_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          custom_pre_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          fsa_dependent_care: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          fsa_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          hsa_post: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          hsa_pre: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          :s125_dental => FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          :s125_medical => FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          :s125_vision => FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          simple: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+          simple_ira: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+        }
+
+      class BenefitsSupport < FinchAPI::BaseModel
+        attr_accessor commuter: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor custom_post_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor custom_pre_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor fsa_dependent_care: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor fsa_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor hsa_post: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor hsa_pre: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor s125_dental: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor s125_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor s125_vision: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor simple: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        attr_accessor simple_ira: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+
+        def initialize:
+          (
+            commuter: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            custom_post_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            custom_pre_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            fsa_dependent_care: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            fsa_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            hsa_post: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            hsa_pre: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            s125_dental: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            s125_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            s125_vision: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            simple: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?,
+            simple_ira: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::benefits_support | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::benefits_support
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/benfit_contribution.rbs

@@ -0,0 +1,8 @@
+module FinchAPI
+  module Models
+    module HRIS
+      
+      class BenfitContribution = FinchAPI::Models::HRIS::BenefitContribution
+    end
+  end
+end

data/sig/finch-api/models/hris/company.rbs

@@ -0,0 +1,195 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type hris_company =
+        {
+          id: String,
+          accounts: ::Array[FinchAPI::Models::HRIS::HRISCompany::Account]?,
+          departments: ::Array[FinchAPI::Models::HRIS::HRISCompany::Department?]?,
+          ein: String?,
+          entity: FinchAPI::Models::HRIS::HRISCompany::Entity?,
+          legal_name: String?,
+          locations: ::Array[FinchAPI::Models::Location?]?,
+          primary_email: String?,
+          primary_phone_number: String?
+        }
+
+      class HRISCompany < FinchAPI::BaseModel
+        attr_accessor id: String
+
+        attr_accessor accounts: ::Array[FinchAPI::Models::HRIS::HRISCompany::Account]?
+
+        attr_accessor departments: ::Array[FinchAPI::Models::HRIS::HRISCompany::Department?]?
+
+        attr_accessor ein: String?
+
+        attr_accessor entity: FinchAPI::Models::HRIS::HRISCompany::Entity?
+
+        attr_accessor legal_name: String?
+
+        attr_accessor locations: ::Array[FinchAPI::Models::Location?]?
+
+        attr_accessor primary_email: String?
+
+        attr_accessor primary_phone_number: String?
+
+        def initialize:
+          (
+            id: String,
+            accounts: ::Array[FinchAPI::Models::HRIS::HRISCompany::Account]?,
+            departments: ::Array[FinchAPI::Models::HRIS::HRISCompany::Department?]?,
+            ein: String?,
+            entity: FinchAPI::Models::HRIS::HRISCompany::Entity?,
+            legal_name: String?,
+            locations: ::Array[FinchAPI::Models::Location?]?,
+            primary_email: String?,
+            primary_phone_number: String?
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::hris_company | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::hris_company
+
+        type account =
+          {
+            account_name: String?,
+            account_number: String?,
+            account_type: FinchAPI::Models::HRIS::HRISCompany::Account::account_type?,
+            institution_name: String?,
+            routing_number: String?
+          }
+
+        class Account < FinchAPI::BaseModel
+          attr_accessor account_name: String?
+
+          attr_accessor account_number: String?
+
+          attr_accessor account_type: FinchAPI::Models::HRIS::HRISCompany::Account::account_type?
+
+          attr_accessor institution_name: String?
+
+          attr_accessor routing_number: String?
+
+          def initialize:
+            (
+              account_name: String?,
+              account_number: String?,
+              account_type: FinchAPI::Models::HRIS::HRISCompany::Account::account_type?,
+              institution_name: String?,
+              routing_number: String?
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::HRISCompany::account
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::account
+
+          type account_type = :checking | :savings
+
+          class AccountType < FinchAPI::Enum
+            CHECKING: :checking
+            SAVINGS: :savings
+
+            def self.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Account::account_type]
+          end
+        end
+
+        type department =
+          {
+            name: String?,
+            parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent?
+          }
+
+        class Department < FinchAPI::BaseModel
+          attr_accessor name: String?
+
+          attr_accessor parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent?
+
+          def initialize:
+            (
+              name: String?,
+              parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent?
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::HRISCompany::department
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::department
+
+          type parent = { name: String? }
+
+          class Parent < FinchAPI::BaseModel
+            attr_accessor name: String?
+
+            def initialize:
+              (name: String?) -> void
+              | (
+                ?FinchAPI::Models::HRIS::HRISCompany::Department::parent
+                | FinchAPI::BaseModel data
+              ) -> void
+
+            def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::Department::parent
+          end
+        end
+
+        type entity =
+          {
+            subtype: FinchAPI::Models::HRIS::HRISCompany::Entity::subtype?,
+            type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_?
+          }
+
+        class Entity < FinchAPI::BaseModel
+          attr_accessor subtype: FinchAPI::Models::HRIS::HRISCompany::Entity::subtype?
+
+          attr_accessor type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_?
+
+          def initialize:
+            (
+              subtype: FinchAPI::Models::HRIS::HRISCompany::Entity::subtype?,
+              type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_?
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::HRISCompany::entity
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::entity
+
+          type subtype = :s_corporation | :c_corporation | :b_corporation
+
+          class Subtype < FinchAPI::Enum
+            S_CORPORATION: :s_corporation
+            C_CORPORATION: :c_corporation
+            B_CORPORATION: :b_corporation
+
+            def self.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::subtype]
+          end
+
+          type type_ =
+            :llc
+            | :lp
+            | :corporation
+            | :sole_proprietor
+            | :non_profit
+            | :partnership
+            | :cooperative
+
+          class Type < FinchAPI::Enum
+            LLC: :llc
+            LP: :lp
+            CORPORATION: :corporation
+            SOLE_PROPRIETOR: :sole_proprietor
+            NON_PROFIT: :non_profit
+            PARTNERSHIP: :partnership
+            COOPERATIVE: :cooperative
+
+            def self.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::type_]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/company_benefit.rbs

@@ -0,0 +1,36 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type company_benefit =
+        {
+          benefit_id: String,
+          description: String?,
+          frequency: FinchAPI::Models::HRIS::benefit_frequency?,
+          type: FinchAPI::Models::HRIS::benefit_type?
+        }
+
+      class CompanyBenefit < FinchAPI::BaseModel
+        attr_accessor benefit_id: String
+
+        attr_accessor description: String?
+
+        attr_accessor frequency: FinchAPI::Models::HRIS::benefit_frequency?
+
+        attr_accessor type: FinchAPI::Models::HRIS::benefit_type?
+
+        def initialize:
+          (
+            benefit_id: String,
+            description: String?,
+            frequency: FinchAPI::Models::HRIS::benefit_frequency?,
+            type: FinchAPI::Models::HRIS::benefit_type?
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::company_benefit | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::company_benefit
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/company_retrieve_params.rbs

@@ -0,0 +1,21 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type company_retrieve_params = {  } & FinchAPI::request_parameters
+
+      class CompanyRetrieveParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        def initialize:
+          (request_options: FinchAPI::request_opts) -> void
+          | (
+            ?FinchAPI::Models::HRIS::company_retrieve_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::company_retrieve_params
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/create_company_benefits_response.rbs

@@ -0,0 +1,20 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type create_company_benefits_response = { benefit_id: String }
+
+      class CreateCompanyBenefitsResponse < FinchAPI::BaseModel
+        attr_accessor benefit_id: String
+
+        def initialize:
+          (benefit_id: String) -> void
+          | (
+            ?FinchAPI::Models::HRIS::create_company_benefits_response
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::create_company_benefits_response
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/directory_list_individuals_params.rbs

@@ -0,0 +1,34 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type directory_list_individuals_params =
+        { limit: Integer, offset: Integer } & FinchAPI::request_parameters
+
+      class DirectoryListIndividualsParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        attr_reader offset: Integer?
+
+        def offset=: (Integer) -> Integer
+
+        def initialize:
+          (
+            limit: Integer,
+            offset: Integer,
+            request_options: FinchAPI::request_opts
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::directory_list_individuals_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::directory_list_individuals_params
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/directory_list_params.rbs

@@ -0,0 +1,34 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type directory_list_params =
+        { limit: Integer, offset: Integer } & FinchAPI::request_parameters
+
+      class DirectoryListParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        attr_reader offset: Integer?
+
+        def offset=: (Integer) -> Integer
+
+        def initialize:
+          (
+            limit: Integer,
+            offset: Integer,
+            request_options: FinchAPI::request_opts
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::directory_list_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::directory_list_params
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/document_list_params.rbs

@@ -0,0 +1,61 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type document_list_params =
+        {
+          individual_ids: ::Array[String],
+          limit: Integer,
+          offset: Integer,
+          types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_]
+        }
+        & FinchAPI::request_parameters
+
+      class DocumentListParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        attr_reader individual_ids: ::Array[String]?
+
+        def individual_ids=: (::Array[String]) -> ::Array[String]
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        attr_reader offset: Integer?
+
+        def offset=: (Integer) -> Integer
+
+        attr_reader types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_]?
+
+        def types=: (
+          ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_]
+        ) -> ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_]
+
+        def initialize:
+          (
+            individual_ids: ::Array[String],
+            limit: Integer,
+            offset: Integer,
+            types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_],
+            request_options: FinchAPI::request_opts
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::document_list_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::document_list_params
+
+        type type_ = :w4_2020 | :w4_2005
+
+        class Type < FinchAPI::Enum
+          W4_2020: :w4_2020
+          W4_2005: :w4_2005
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_]
+        end
+      end
+    end
+  end
+end

data/sig/finch-api/models/hris/document_list_response.rbs

@@ -0,0 +1,29 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type document_list_response =
+        {
+          documents: ::Array[FinchAPI::Models::HRIS::DocumentResponse],
+          paging: FinchAPI::Models::Paging
+        }
+
+      class DocumentListResponse < FinchAPI::BaseModel
+        attr_accessor documents: ::Array[FinchAPI::Models::HRIS::DocumentResponse]
+
+        attr_accessor paging: FinchAPI::Models::Paging
+
+        def initialize:
+          (
+            documents: ::Array[FinchAPI::Models::HRIS::DocumentResponse],
+            paging: FinchAPI::Models::Paging
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::document_list_response
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::document_list_response
+      end
+    end
+  end
+end