finch-api 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.14

data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_params.rbs

@@ -0,0 +1,27 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module Company
+        module PayStatementItem
+          type rule_update_params =
+            { optional_property: top }
+            & FinchAPI::Internal::Type::request_parameters
+
+          class RuleUpdateParams < FinchAPI::Internal::Type::BaseModel
+            extend FinchAPI::Internal::Type::RequestParameters::Converter
+            include FinchAPI::Internal::Type::RequestParameters
+
+            attr_reader optional_property: top?
+
+            def optional_property=: (top) -> top
+
+            def initialize: (
+              ?optional_property: top,
+              ?request_options: FinchAPI::request_opts
+            ) -> void
+          end
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbs

@@ -0,0 +1,133 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module Company
+        module PayStatementItem
+          type rule_update_response =
+            {
+              id: String,
+              attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes,
+              conditions: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition],
+              created_at: Time,
+              effective_end_date: String?,
+              effective_start_date: String?,
+              entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::entity_type,
+              priority: Integer,
+              updated_at: Time
+            }
+
+          class RuleUpdateResponse < FinchAPI::Internal::Type::BaseModel
+            attr_reader id: String?
+
+            def id=: (String) -> String
+
+            attr_reader attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes?
+
+            def attributes=: (
+              FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes
+            ) -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes
+
+            attr_reader conditions: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition]?
+
+            def conditions=: (
+              ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition]
+            ) -> ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition]
+
+            attr_reader created_at: Time?
+
+            def created_at=: (Time) -> Time
+
+            attr_accessor effective_end_date: String?
+
+            attr_accessor effective_start_date: String?
+
+            attr_reader entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::entity_type?
+
+            def entity_type=: (
+              FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::entity_type
+            ) -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::entity_type
+
+            attr_reader priority: Integer?
+
+            def priority=: (Integer) -> Integer
+
+            attr_reader updated_at: Time?
+
+            def updated_at=: (Time) -> Time
+
+            def initialize: (
+              ?id: String,
+              ?attributes: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes,
+              ?conditions: ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition],
+              ?created_at: Time,
+              ?effective_end_date: String?,
+              ?effective_start_date: String?,
+              ?entity_type: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::entity_type,
+              ?priority: Integer,
+              ?updated_at: Time
+            ) -> void
+
+            type attributes = { metadata: ::Hash[Symbol, top] }
+
+            class Attributes < FinchAPI::Internal::Type::BaseModel
+              attr_reader metadata: ::Hash[Symbol, top]?
+
+              def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+              def initialize: (?metadata: ::Hash[Symbol, top]) -> void
+            end
+
+            type condition =
+              {
+                field: String,
+                operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::operator,
+                value: String
+              }
+
+            class Condition < FinchAPI::Internal::Type::BaseModel
+              attr_reader field: String?
+
+              def field=: (String) -> String
+
+              attr_reader operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::operator?
+
+              def operator=: (
+                FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::operator
+              ) -> FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::operator
+
+              attr_reader value: String?
+
+              def value=: (String) -> String
+
+              def initialize: (
+                ?field: String,
+                ?operator: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::operator,
+                ?value: String
+              ) -> void
+
+              type operator = :equals
+
+              module Operator
+                extend FinchAPI::Internal::Type::Enum
+
+                EQUALS: :equals
+
+                def self?.values: -> ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::operator]
+              end
+            end
+
+            type entity_type = :pay_statement_item
+
+            module EntityType
+              extend FinchAPI::Internal::Type::Enum
+
+              PAY_STATEMENT_ITEM: :pay_statement_item
+
+              def self?.values: -> ::Array[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::entity_type]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/company/pay_statement_item_list_params.rbs

@@ -0,0 +1,67 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module Company
+        type pay_statement_item_list_params =
+          {
+            categories: ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category],
+            end_date: Date,
+            name: String,
+            start_date: Date,
+            type: String
+          }
+          & FinchAPI::Internal::Type::request_parameters
+
+        class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          attr_reader categories: ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category]?
+
+          def categories=: (
+            ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category]
+          ) -> ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category]
+
+          attr_reader end_date: Date?
+
+          def end_date=: (Date) -> Date
+
+          attr_reader name: String?
+
+          def name=: (String) -> String
+
+          attr_reader start_date: Date?
+
+          def start_date=: (Date) -> Date
+
+          attr_reader type: String?
+
+          def type=: (String) -> String
+
+          def initialize: (
+            ?categories: ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category],
+            ?end_date: Date,
+            ?name: String,
+            ?start_date: Date,
+            ?type: String,
+            ?request_options: FinchAPI::request_opts
+          ) -> void
+
+          type category =
+            :earnings | :taxes | :employee_deductions | :employer_contributions
+
+          module Category
+            extend FinchAPI::Internal::Type::Enum
+
+            EARNINGS: :earnings
+            TAXES: :taxes
+            EMPLOYEE_DEDUCTIONS: :employee_deductions
+            EMPLOYER_CONTRIBUTIONS: :employer_contributions
+
+            def self?.values: -> ::Array[FinchAPI::HRIS::Company::PayStatementItemListParams::category]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/company/pay_statement_item_list_response.rbs

@@ -0,0 +1,77 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module Company
+        type pay_statement_item_list_response =
+          {
+            attributes: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes,
+            category: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::category,
+            name: String
+          }
+
+        class PayStatementItemListResponse < FinchAPI::Internal::Type::BaseModel
+          attr_reader attributes: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes?
+
+          def attributes=: (
+            FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes
+          ) -> FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes
+
+          attr_reader category: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::category?
+
+          def category=: (
+            FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::category
+          ) -> FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::category
+
+          attr_reader name: String?
+
+          def name=: (String) -> String
+
+          def initialize: (
+            ?attributes: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes,
+            ?category: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::category,
+            ?name: String
+          ) -> void
+
+          type attributes =
+            {
+              employer: bool?,
+              metadata: ::Hash[Symbol, top?]?,
+              pre_tax: bool?,
+              type: String?
+            }
+
+          class Attributes < FinchAPI::Internal::Type::BaseModel
+            attr_accessor employer: bool?
+
+            attr_accessor metadata: ::Hash[Symbol, top?]?
+
+            attr_accessor pre_tax: bool?
+
+            attr_accessor type: String?
+
+            def initialize: (
+              ?employer: bool?,
+              ?metadata: ::Hash[Symbol, top?]?,
+              ?pre_tax: bool?,
+              ?type: String?
+            ) -> void
+          end
+
+          type category =
+            :earnings | :taxes | :employee_deductions | :employer_contributions
+
+          module Category
+            extend FinchAPI::Internal::Type::Enum
+
+            EARNINGS: :earnings
+            TAXES: :taxes
+            EMPLOYEE_DEDUCTIONS: :employee_deductions
+            EMPLOYER_CONTRIBUTIONS: :employer_contributions
+
+            def self?.values: -> ::Array[FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::category]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/company.rbs

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

data/sig/finch_api/models/hris/company_benefit.rbs

@@ -0,0 +1,83 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type company_benefit =
+        {
+          benefit_id: String,
+          company_contribution: FinchAPI::HRIS::CompanyBenefit::CompanyContribution?,
+          description: String?,
+          frequency: FinchAPI::Models::HRIS::benefit_frequency?,
+          type: FinchAPI::Models::HRIS::benefit_type?
+        }
+
+      class CompanyBenefit < FinchAPI::Internal::Type::BaseModel
+        attr_accessor benefit_id: String
+
+        attr_accessor company_contribution: FinchAPI::HRIS::CompanyBenefit::CompanyContribution?
+
+        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,
+          company_contribution: FinchAPI::HRIS::CompanyBenefit::CompanyContribution?,
+          description: String?,
+          frequency: FinchAPI::Models::HRIS::benefit_frequency?,
+          type: FinchAPI::Models::HRIS::benefit_type?
+        ) -> void
+
+        type company_contribution =
+          {
+            tiers: ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier],
+            type: FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_
+          }
+
+        class CompanyContribution < FinchAPI::Internal::Type::BaseModel
+          attr_reader tiers: ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier]?
+
+          def tiers=: (
+            ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier]
+          ) -> ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier]
+
+          attr_reader type: FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_?
+
+          def type=: (
+            FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_
+          ) -> FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_
+
+          def initialize: (
+            ?tiers: ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::Tier],
+            ?type: FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_
+          ) -> void
+
+          type tier = { match: Integer, threshold: Integer }
+
+          class Tier < FinchAPI::Internal::Type::BaseModel
+            attr_reader match: Integer?
+
+            def match=: (Integer) -> Integer
+
+            attr_reader threshold: Integer?
+
+            def threshold=: (Integer) -> Integer
+
+            def initialize: (?match: Integer, ?threshold: Integer) -> void
+          end
+
+          type type_ = :match
+
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            MATCH: :match
+
+            def self?.values: -> ::Array[FinchAPI::HRIS::CompanyBenefit::CompanyContribution::type_]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/company_retrieve_params.rbs

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

data/sig/finch_api/models/hris/create_company_benefits_response.rbs

@@ -0,0 +1,16 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type create_company_benefits_response =
+        { benefit_id: String, job_id: String }
+
+      class CreateCompanyBenefitsResponse < FinchAPI::Internal::Type::BaseModel
+        attr_accessor benefit_id: String
+
+        attr_accessor job_id: String
+
+        def initialize: (benefit_id: String, job_id: String) -> void
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/directory_list_individuals_params.rbs

@@ -0,0 +1,28 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type directory_list_individuals_params =
+        { limit: Integer, offset: Integer }
+        & FinchAPI::Internal::Type::request_parameters
+
+      class DirectoryListIndividualsParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::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
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/directory_list_params.rbs

@@ -0,0 +1,28 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type directory_list_params =
+        { limit: Integer, offset: Integer }
+        & FinchAPI::Internal::Type::request_parameters
+
+      class DirectoryListParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::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
+      end
+    end
+  end
+end