finch-api 0.1.0.pre.alpha.1

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

@@ -0,0 +1,58 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type document_response =
+        {
+          id: String,
+          individual_id: String?,
+          type: FinchAPI::Models::HRIS::DocumentResponse::type_,
+          url: String,
+          year: Float?
+        }
+
+      class DocumentResponse < FinchAPI::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_accessor individual_id: String?
+
+        attr_reader type: FinchAPI::Models::HRIS::DocumentResponse::type_?
+
+        def type=: (
+          FinchAPI::Models::HRIS::DocumentResponse::type_
+        ) -> FinchAPI::Models::HRIS::DocumentResponse::type_
+
+        attr_reader url: String?
+
+        def url=: (String) -> String
+
+        attr_accessor year: Float?
+
+        def initialize:
+          (
+            id: String,
+            individual_id: String?,
+            type: FinchAPI::Models::HRIS::DocumentResponse::type_,
+            url: String,
+            year: Float?
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::document_response
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::document_response
+
+        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::DocumentResponse::type_]
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,12 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type document_retreive_response =
+        FinchAPI::Models::HRIS::W42020 | FinchAPI::Models::HRIS::W42005
+
+      class DocumentRetreiveResponse < FinchAPI::Union
+        private def self.variants: -> [[:w4_2020, FinchAPI::Models::HRIS::W42020], [:w4_2005, FinchAPI::Models::HRIS::W42005]]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,228 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type employment_data =
+        {
+          id: String,
+          class_code: String?,
+          custom_fields: ::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]?,
+          department: FinchAPI::Models::HRIS::EmploymentData::Department?,
+          employment: FinchAPI::Models::HRIS::EmploymentData::Employment?,
+          employment_status: FinchAPI::Models::HRIS::EmploymentData::employment_status?,
+          end_date: String?,
+          first_name: String?,
+          income: FinchAPI::Models::Income?,
+          income_history: ::Array[FinchAPI::Models::Income?]?,
+          is_active: bool?,
+          last_name: String?,
+          latest_rehire_date: String?,
+          location: FinchAPI::Models::Location?,
+          manager: FinchAPI::Models::HRIS::EmploymentData::Manager?,
+          middle_name: String?,
+          source_id: String?,
+          start_date: String?,
+          title: String?,
+          work_id: String?
+        }
+
+      class EmploymentData < FinchAPI::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_accessor class_code: String?
+
+        attr_accessor custom_fields: ::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]?
+
+        attr_accessor department: FinchAPI::Models::HRIS::EmploymentData::Department?
+
+        attr_accessor employment: FinchAPI::Models::HRIS::EmploymentData::Employment?
+
+        attr_accessor employment_status: FinchAPI::Models::HRIS::EmploymentData::employment_status?
+
+        attr_accessor end_date: String?
+
+        attr_accessor first_name: String?
+
+        attr_accessor income: FinchAPI::Models::Income?
+
+        attr_accessor income_history: ::Array[FinchAPI::Models::Income?]?
+
+        attr_accessor is_active: bool?
+
+        attr_accessor last_name: String?
+
+        attr_accessor latest_rehire_date: String?
+
+        attr_accessor location: FinchAPI::Models::Location?
+
+        attr_accessor manager: FinchAPI::Models::HRIS::EmploymentData::Manager?
+
+        attr_accessor middle_name: String?
+
+        attr_accessor source_id: String?
+
+        attr_accessor start_date: String?
+
+        attr_accessor title: String?
+
+        attr_accessor work_id: String?
+
+        def initialize:
+          (
+            id: String,
+            class_code: String?,
+            custom_fields: ::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]?,
+            department: FinchAPI::Models::HRIS::EmploymentData::Department?,
+            employment: FinchAPI::Models::HRIS::EmploymentData::Employment?,
+            employment_status: FinchAPI::Models::HRIS::EmploymentData::employment_status?,
+            end_date: String?,
+            first_name: String?,
+            income: FinchAPI::Models::Income?,
+            income_history: ::Array[FinchAPI::Models::Income?]?,
+            is_active: bool?,
+            last_name: String?,
+            latest_rehire_date: String?,
+            location: FinchAPI::Models::Location?,
+            manager: FinchAPI::Models::HRIS::EmploymentData::Manager?,
+            middle_name: String?,
+            source_id: String?,
+            start_date: String?,
+            title: String?,
+            work_id: String?
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::employment_data | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::employment_data
+
+        type custom_field = { name: String, value: top }
+
+        class CustomField < FinchAPI::BaseModel
+          attr_reader name: String?
+
+          def name=: (String) -> String
+
+          attr_reader value: top?
+
+          def value=: (top) -> top
+
+          def initialize:
+            (name: String, value: top) -> void
+            | (
+              ?FinchAPI::Models::HRIS::EmploymentData::custom_field
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::custom_field
+        end
+
+        type department = { name: String? }
+
+        class Department < FinchAPI::BaseModel
+          attr_accessor name: String?
+
+          def initialize:
+            (name: String?) -> void
+            | (
+              ?FinchAPI::Models::HRIS::EmploymentData::department
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::department
+        end
+
+        type employment =
+          {
+            subtype: FinchAPI::Models::HRIS::EmploymentData::Employment::subtype?,
+            type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_?
+          }
+
+        class Employment < FinchAPI::BaseModel
+          attr_accessor subtype: FinchAPI::Models::HRIS::EmploymentData::Employment::subtype?
+
+          attr_accessor type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_?
+
+          def initialize:
+            (
+              subtype: FinchAPI::Models::HRIS::EmploymentData::Employment::subtype?,
+              type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_?
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::EmploymentData::employment
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::employment
+
+          type subtype =
+            :full_time
+            | :intern
+            | :part_time
+            | :temp
+            | :seasonal
+            | :individual_contractor
+
+          class Subtype < FinchAPI::Enum
+            FULL_TIME: :full_time
+            INTERN: :intern
+            PART_TIME: :part_time
+            TEMP: :temp
+            SEASONAL: :seasonal
+            INDIVIDUAL_CONTRACTOR: :individual_contractor
+
+            def self.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::subtype]
+          end
+
+          type type_ = :employee | :contractor
+
+          class Type < FinchAPI::Enum
+            EMPLOYEE: :employee
+            CONTRACTOR: :contractor
+
+            def self.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::type_]
+          end
+        end
+
+        type employment_status =
+          :active
+          | :deceased
+          | :leave
+          | :onboarding
+          | :prehire
+          | :retired
+          | :terminated
+
+        class EmploymentStatus < FinchAPI::Enum
+          ACTIVE: :active
+          DECEASED: :deceased
+          LEAVE: :leave
+          ONBOARDING: :onboarding
+          PREHIRE: :prehire
+          RETIRED: :retired
+          TERMINATED: :terminated
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::employment_status]
+        end
+
+        type manager = { id: String }
+
+        class Manager < FinchAPI::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          def initialize:
+            (id: String) -> void
+            | (
+              ?FinchAPI::Models::HRIS::EmploymentData::manager
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::manager
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type employment_data_response =
+        {
+          body: FinchAPI::Models::HRIS::EmploymentData,
+          code: Integer,
+          individual_id: String
+        }
+
+      class EmploymentDataResponse < FinchAPI::BaseModel
+        attr_reader body: FinchAPI::Models::HRIS::EmploymentData?
+
+        def body=: (
+          FinchAPI::Models::HRIS::EmploymentData
+        ) -> FinchAPI::Models::HRIS::EmploymentData
+
+        attr_reader code: Integer?
+
+        def code=: (Integer) -> Integer
+
+        attr_reader individual_id: String?
+
+        def individual_id=: (String) -> String
+
+        def initialize:
+          (
+            body: FinchAPI::Models::HRIS::EmploymentData,
+            code: Integer,
+            individual_id: String
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::employment_data_response
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::employment_data_response
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type employment_retrieve_many_params =
+        {
+          requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request]
+        }
+        & FinchAPI::request_parameters
+
+      class EmploymentRetrieveManyParams < FinchAPI::BaseModel
+        extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        attr_accessor requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request]
+
+        def initialize:
+          (
+            requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request],
+            request_options: FinchAPI::request_opts
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::employment_retrieve_many_params
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::employment_retrieve_many_params
+
+        type request = { individual_id: String }
+
+        class Request < FinchAPI::BaseModel
+          attr_accessor individual_id: String
+
+          def initialize:
+            (individual_id: String) -> void
+            | (
+              ?FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::request
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::request
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,176 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type individual =
+        {
+          id: String,
+          dob: String?,
+          emails: ::Array[FinchAPI::Models::HRIS::Individual::Email]?,
+          encrypted_ssn: String?,
+          ethnicity: FinchAPI::Models::HRIS::Individual::ethnicity?,
+          first_name: String?,
+          gender: FinchAPI::Models::HRIS::Individual::gender?,
+          last_name: String?,
+          middle_name: String?,
+          phone_numbers: ::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber?]?,
+          preferred_name: String?,
+          residence: FinchAPI::Models::Location?,
+          ssn: String?
+        }
+
+      class Individual < FinchAPI::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_accessor dob: String?
+
+        attr_accessor emails: ::Array[FinchAPI::Models::HRIS::Individual::Email]?
+
+        attr_accessor encrypted_ssn: String?
+
+        attr_accessor ethnicity: FinchAPI::Models::HRIS::Individual::ethnicity?
+
+        attr_accessor first_name: String?
+
+        attr_accessor gender: FinchAPI::Models::HRIS::Individual::gender?
+
+        attr_accessor last_name: String?
+
+        attr_accessor middle_name: String?
+
+        attr_accessor phone_numbers: ::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber?]?
+
+        attr_accessor preferred_name: String?
+
+        attr_accessor residence: FinchAPI::Models::Location?
+
+        attr_accessor ssn: String?
+
+        def initialize:
+          (
+            id: String,
+            dob: String?,
+            emails: ::Array[FinchAPI::Models::HRIS::Individual::Email]?,
+            encrypted_ssn: String?,
+            ethnicity: FinchAPI::Models::HRIS::Individual::ethnicity?,
+            first_name: String?,
+            gender: FinchAPI::Models::HRIS::Individual::gender?,
+            last_name: String?,
+            middle_name: String?,
+            phone_numbers: ::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber?]?,
+            preferred_name: String?,
+            residence: FinchAPI::Models::Location?,
+            ssn: String?
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::individual | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::individual
+
+        type email =
+          {
+            data: String,
+            type: FinchAPI::Models::HRIS::Individual::Email::type_?
+          }
+
+        class Email < FinchAPI::BaseModel
+          attr_reader data: String?
+
+          def data=: (String) -> String
+
+          attr_accessor type: FinchAPI::Models::HRIS::Individual::Email::type_?
+
+          def initialize:
+            (
+              data: String,
+              type: FinchAPI::Models::HRIS::Individual::Email::type_?
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::Individual::email
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::Individual::email
+
+          type type_ = :work | :personal
+
+          class Type < FinchAPI::Enum
+            WORK: :work
+            PERSONAL: :personal
+
+            def self.values: -> ::Array[FinchAPI::Models::HRIS::Individual::Email::type_]
+          end
+        end
+
+        type ethnicity =
+          :asian
+          | :white
+          | :black_or_african_american
+          | :native_hawaiian_or_pacific_islander
+          | :american_indian_or_alaska_native
+          | :hispanic_or_latino
+          | :two_or_more_races
+          | :decline_to_specify
+
+        class Ethnicity < FinchAPI::Enum
+          ASIAN: :asian
+          WHITE: :white
+          BLACK_OR_AFRICAN_AMERICAN: :black_or_african_american
+          NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER: :native_hawaiian_or_pacific_islander
+          AMERICAN_INDIAN_OR_ALASKA_NATIVE: :american_indian_or_alaska_native
+          HISPANIC_OR_LATINO: :hispanic_or_latino
+          TWO_OR_MORE_RACES: :two_or_more_races
+          DECLINE_TO_SPECIFY: :decline_to_specify
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::Individual::ethnicity]
+        end
+
+        type gender = :female | :male | :other | :decline_to_specify
+
+        class Gender < FinchAPI::Enum
+          FEMALE: :female
+          MALE: :male
+          OTHER: :other
+          DECLINE_TO_SPECIFY: :decline_to_specify
+
+          def self.values: -> ::Array[FinchAPI::Models::HRIS::Individual::gender]
+        end
+
+        type phone_number =
+          {
+            data: String?,
+            type: FinchAPI::Models::HRIS::Individual::PhoneNumber::type_?
+          }
+
+        class PhoneNumber < FinchAPI::BaseModel
+          attr_accessor data: String?
+
+          attr_accessor type: FinchAPI::Models::HRIS::Individual::PhoneNumber::type_?
+
+          def initialize:
+            (
+              data: String?,
+              type: FinchAPI::Models::HRIS::Individual::PhoneNumber::type_?
+            ) -> void
+            | (
+              ?FinchAPI::Models::HRIS::Individual::phone_number
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::Individual::phone_number
+
+          type type_ = :work | :personal
+
+          class Type < FinchAPI::Enum
+            WORK: :work
+            PERSONAL: :personal
+
+            def self.values: -> ::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber::type_]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type individual_in_directory =
+        {
+          id: String,
+          department: FinchAPI::Models::HRIS::IndividualInDirectory::Department?,
+          first_name: String?,
+          is_active: bool?,
+          last_name: String?,
+          manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager?,
+          middle_name: String?
+        }
+
+      class IndividualInDirectory < FinchAPI::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_accessor department: FinchAPI::Models::HRIS::IndividualInDirectory::Department?
+
+        attr_accessor first_name: String?
+
+        attr_accessor is_active: bool?
+
+        attr_accessor last_name: String?
+
+        attr_accessor manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager?
+
+        attr_accessor middle_name: String?
+
+        def initialize:
+          (
+            id: String,
+            department: FinchAPI::Models::HRIS::IndividualInDirectory::Department?,
+            first_name: String?,
+            is_active: bool?,
+            last_name: String?,
+            manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager?,
+            middle_name: String?
+          ) -> void
+          | (
+            ?FinchAPI::Models::HRIS::individual_in_directory
+            | FinchAPI::BaseModel data
+          ) -> void
+
+        def to_hash: -> FinchAPI::Models::HRIS::individual_in_directory
+
+        type department = { name: String? }
+
+        class Department < FinchAPI::BaseModel
+          attr_accessor name: String?
+
+          def initialize:
+            (name: String?) -> void
+            | (
+              ?FinchAPI::Models::HRIS::IndividualInDirectory::department
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::IndividualInDirectory::department
+        end
+
+        type manager = { id: String }
+
+        class Manager < FinchAPI::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          def initialize:
+            (id: String) -> void
+            | (
+              ?FinchAPI::Models::HRIS::IndividualInDirectory::manager
+              | FinchAPI::BaseModel data
+            ) -> void
+
+          def to_hash: -> FinchAPI::Models::HRIS::IndividualInDirectory::manager
+        end
+      end
+    end
+  end
+end