finch-api 0.1.0.pre.alpha.1

data/lib/finch-api/models/hris/document_list_params.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class DocumentListParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!attribute [r] individual_ids
+        #   Comma-delimited list of stable Finch uuids for each individual. If empty,
+        #     defaults to all individuals
+        #
+        #   @return [Array<String>, nil]
+        optional :individual_ids, FinchAPI::ArrayOf[String]
+
+        # @!parse
+        #   # @return [Array<String>]
+        #   attr_writer :individual_ids
+
+        # @!attribute [r] limit
+        #   Number of documents to return (defaults to all)
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :limit
+
+        # @!attribute [r] offset
+        #   Index to start from (defaults to 0)
+        #
+        #   @return [Integer, nil]
+        optional :offset, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :offset
+
+        # @!attribute [r] types
+        #   Comma-delimited list of document types to filter on. If empty, defaults to all
+        #     types
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>, nil]
+        optional :types, -> { FinchAPI::ArrayOf[enum: FinchAPI::Models::HRIS::DocumentListParams::Type] }
+
+        # @!parse
+        #   # @return [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>]
+        #   attr_writer :types
+
+        # @!parse
+        #   # @param individual_ids [Array<String>]
+        #   # @param limit [Integer]
+        #   # @param offset [Integer]
+        #   # @param types [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # @example
+        # ```ruby
+        # case type
+        # in :w4_2020
+        #   # ...
+        # in :w4_2005
+        #   # ...
+        # end
+        # ```
+        class Type < FinchAPI::Enum
+          W4_2020 = :w4_2020
+          W4_2005 = :w4_2005
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/document_list_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class DocumentListResponse < FinchAPI::BaseModel
+        # @!attribute documents
+        #
+        #   @return [Array<FinchAPI::Models::HRIS::DocumentResponse>]
+        required :documents, -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::DocumentResponse] }
+
+        # @!attribute paging
+        #
+        #   @return [FinchAPI::Models::Paging]
+        required :paging, -> { FinchAPI::Models::Paging }
+
+        # @!parse
+        #   # @param documents [Array<FinchAPI::Models::HRIS::DocumentResponse>]
+        #   # @param paging [FinchAPI::Models::Paging]
+        #   #
+        #   def initialize(documents:, paging:, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/document_response.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class DocumentResponse < FinchAPI::BaseModel
+        # @!attribute [r] id
+        #   A stable Finch id for the document.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :id
+
+        # @!attribute individual_id
+        #   The ID of the individual associated with the document. This will be null for
+        #     employer-level documents.
+        #
+        #   @return [String, nil]
+        optional :individual_id, String, nil?: true
+
+        # @!attribute [r] type
+        #   The type of document.
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type, nil]
+        optional :type, enum: -> { FinchAPI::Models::HRIS::DocumentResponse::Type }
+
+        # @!parse
+        #   # @return [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type]
+        #   attr_writer :type
+
+        # @!attribute [r] url
+        #   A URL to access the document. Format:
+        #     `https://api.tryfinch.com/employer/documents/:document_id`.
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :url
+
+        # @!attribute year
+        #   The year the document applies to, if available.
+        #
+        #   @return [Float, nil]
+        optional :year, Float, nil?: true
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param individual_id [String, nil]
+        #   # @param type [Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type]
+        #   # @param url [String]
+        #   # @param year [Float, nil]
+        #   #
+        #   def initialize(id: nil, individual_id: nil, type: nil, url: nil, year: nil, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        # @abstract
+        #
+        # The type of document.
+        #
+        # @example
+        # ```ruby
+        # case type
+        # in :w4_2020
+        #   # ...
+        # in :w4_2005
+        #   # ...
+        # end
+        # ```
+        class Type < FinchAPI::Enum
+          W4_2020 = :w4_2020
+          W4_2005 = :w4_2005
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/document_retreive_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class DocumentRetreiveParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!parse
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/document_retreive_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @abstract
+      #
+      # A 2020 version of the W-4 tax form containing information on an individual's
+      #   filing status, dependents, and withholding details.
+      #
+      # @example
+      # ```ruby
+      # case document_retreive_response
+      # in {type: "w4_2020", data: FinchAPI::Models::HRIS::W42020::Data, year: Float}
+      #   # FinchAPI::Models::HRIS::W42020 ...
+      # in {type: "w4_2005", data: FinchAPI::Models::HRIS::W42005::Data, year: Float}
+      #   # FinchAPI::Models::HRIS::W42005 ...
+      # end
+      # ```
+      #
+      # @example
+      # ```ruby
+      # case document_retreive_response
+      # in FinchAPI::Models::HRIS::W42020
+      #   # ...
+      # in FinchAPI::Models::HRIS::W42005
+      #   # ...
+      # end
+      # ```
+      class DocumentRetreiveResponse < FinchAPI::Union
+        discriminator :type
+
+        # A 2020 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.
+        variant :w4_2020, -> { FinchAPI::Models::HRIS::W42020 }
+
+        # A 2005 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.
+        variant :w4_2005, -> { FinchAPI::Models::HRIS::W42005 }
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/employment_data.rb

@@ -0,0 +1,380 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class EmploymentData < FinchAPI::BaseModel
+        # @!attribute [r] id
+        #   string A stable Finch `id` (UUID v4) for an individual in the company.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :id
+
+        # @!attribute class_code
+        #   Worker's compensation classification code for this employee
+        #
+        #   @return [String, nil]
+        optional :class_code, String, nil?: true
+
+        # @!attribute custom_fields
+        #   Custom fields for the individual. These are fields which are defined by the
+        #     employer in the system.
+        #
+        #   @return [Array<FinchAPI::Models::HRIS::EmploymentData::CustomField>, nil]
+        optional :custom_fields,
+                 -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::EmploymentData::CustomField] },
+                 nil?: true
+
+        # @!attribute department
+        #   The department object.
+        #
+        #   @return [FinchAPI::Models::HRIS::EmploymentData::Department, nil]
+        optional :department, -> { FinchAPI::Models::HRIS::EmploymentData::Department }, nil?: true
+
+        # @!attribute employment
+        #   The employment object.
+        #
+        #   @return [FinchAPI::Models::HRIS::EmploymentData::Employment, nil]
+        optional :employment, -> { FinchAPI::Models::HRIS::EmploymentData::Employment }, nil?: true
+
+        # @!attribute employment_status
+        #   The detailed employment status of the individual. Available options: `active`,
+        #     `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus, nil]
+        optional :employment_status,
+                 enum: -> { FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus },
+                 nil?: true
+
+        # @!attribute end_date
+        #
+        #   @return [String, nil]
+        optional :end_date, String, nil?: true
+
+        # @!attribute first_name
+        #   The legal first name of the individual.
+        #
+        #   @return [String, nil]
+        optional :first_name, String, nil?: true
+
+        # @!attribute income
+        #   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.
+        #
+        #   @return [FinchAPI::Models::Income, nil]
+        optional :income, -> { FinchAPI::Models::Income }, nil?: true
+
+        # @!attribute income_history
+        #   The array of income history.
+        #
+        #   @return [Array<FinchAPI::Models::Income, nil>, nil]
+        optional :income_history, -> { FinchAPI::ArrayOf[FinchAPI::Models::Income, nil?: true] }, nil?: true
+
+        # @!attribute is_active
+        #   `true` if the individual an an active employee or contractor at the company.
+        #
+        #   @return [Boolean, nil]
+        optional :is_active, FinchAPI::BooleanModel, nil?: true
+
+        # @!attribute last_name
+        #   The legal last name of the individual.
+        #
+        #   @return [String, nil]
+        optional :last_name, String, nil?: true
+
+        # @!attribute latest_rehire_date
+        #
+        #   @return [String, nil]
+        optional :latest_rehire_date, String, nil?: true
+
+        # @!attribute location
+        #
+        #   @return [FinchAPI::Models::Location, nil]
+        optional :location, -> { FinchAPI::Models::Location }, nil?: true
+
+        # @!attribute manager
+        #   The manager object representing the manager of the individual within the org.
+        #
+        #   @return [FinchAPI::Models::HRIS::EmploymentData::Manager, nil]
+        optional :manager, -> { FinchAPI::Models::HRIS::EmploymentData::Manager }, nil?: true
+
+        # @!attribute middle_name
+        #   The legal middle name of the individual.
+        #
+        #   @return [String, nil]
+        optional :middle_name, String, nil?: true
+
+        # @!attribute source_id
+        #   The source system's unique employment identifier for this individual
+        #
+        #   @return [String, nil]
+        optional :source_id, String, nil?: true
+
+        # @!attribute start_date
+        #
+        #   @return [String, nil]
+        optional :start_date, String, nil?: true
+
+        # @!attribute title
+        #   The current title of the individual.
+        #
+        #   @return [String, nil]
+        optional :title, String, nil?: true
+
+        # @!attribute work_id
+        #   This field is deprecated in favour of `source_id`
+        #
+        #   @return [String, nil]
+        optional :work_id, String, nil?: true
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param class_code [String, nil]
+        #   # @param custom_fields [Array<FinchAPI::Models::HRIS::EmploymentData::CustomField>, nil]
+        #   # @param department [FinchAPI::Models::HRIS::EmploymentData::Department, nil]
+        #   # @param employment [FinchAPI::Models::HRIS::EmploymentData::Employment, nil]
+        #   # @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus, nil]
+        #   # @param end_date [String, nil]
+        #   # @param first_name [String, nil]
+        #   # @param income [FinchAPI::Models::Income, nil]
+        #   # @param income_history [Array<FinchAPI::Models::Income, nil>, nil]
+        #   # @param is_active [Boolean, nil]
+        #   # @param last_name [String, nil]
+        #   # @param latest_rehire_date [String, nil]
+        #   # @param location [FinchAPI::Models::Location, nil]
+        #   # @param manager [FinchAPI::Models::HRIS::EmploymentData::Manager, nil]
+        #   # @param middle_name [String, nil]
+        #   # @param source_id [String, nil]
+        #   # @param start_date [String, nil]
+        #   # @param title [String, nil]
+        #   # @param work_id [String, nil]
+        #   #
+        #   def initialize(
+        #     id: nil,
+        #     class_code: nil,
+        #     custom_fields: nil,
+        #     department: nil,
+        #     employment: nil,
+        #     employment_status: nil,
+        #     end_date: nil,
+        #     first_name: nil,
+        #     income: nil,
+        #     income_history: nil,
+        #     is_active: nil,
+        #     last_name: nil,
+        #     latest_rehire_date: nil,
+        #     location: nil,
+        #     manager: nil,
+        #     middle_name: nil,
+        #     source_id: nil,
+        #     start_date: nil,
+        #     title: nil,
+        #     work_id: nil,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        class CustomField < FinchAPI::BaseModel
+          # @!attribute [r] name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :name
+
+          # @!attribute [r] value
+          #
+          #   @return [Object, nil]
+          optional :value, FinchAPI::Unknown
+
+          # @!parse
+          #   # @return [Object]
+          #   attr_writer :value
+
+          # @!parse
+          #   # @param name [String]
+          #   # @param value [Object]
+          #   #
+          #   def initialize(name: nil, value: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+
+        class Department < FinchAPI::BaseModel
+          # @!attribute name
+          #   The name of the department associated with the individual.
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!parse
+          #   # The department object.
+          #   #
+          #   # @param name [String, nil]
+          #   #
+          #   def initialize(name: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+
+        class Employment < FinchAPI::BaseModel
+          # @!attribute subtype
+          #   The secondary employment type of the individual. Options: `full_time`,
+          #     `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype, nil]
+          optional :subtype, enum: -> { FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype }, nil?: true
+
+          # @!attribute type
+          #   The main employment type of the individual.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Type, nil]
+          optional :type, enum: -> { FinchAPI::Models::HRIS::EmploymentData::Employment::Type }, nil?: true
+
+          # @!parse
+          #   # The employment object.
+          #   #
+          #   # @param subtype [Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype, nil]
+          #   # @param type [Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Type, nil]
+          #   #
+          #   def initialize(subtype: nil, type: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+          # @abstract
+          #
+          # The secondary employment type of the individual. Options: `full_time`,
+          #   `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+          #
+          # @example
+          # ```ruby
+          # case subtype
+          # in :full_time
+          #   # ...
+          # in :intern
+          #   # ...
+          # in :part_time
+          #   # ...
+          # in :temp
+          #   # ...
+          # in :seasonal
+          #   # ...
+          # in ...
+          #   #...
+          # end
+          # ```
+          class Subtype < FinchAPI::Enum
+            FULL_TIME = :full_time
+            INTERN = :intern
+            PART_TIME = :part_time
+            TEMP = :temp
+            SEASONAL = :seasonal
+            INDIVIDUAL_CONTRACTOR = :individual_contractor
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+
+          # @abstract
+          #
+          # The main employment type of the individual.
+          #
+          # @example
+          # ```ruby
+          # case type
+          # in :employee
+          #   # ...
+          # in :contractor
+          #   # ...
+          # end
+          # ```
+          class Type < FinchAPI::Enum
+            EMPLOYEE = :employee
+            CONTRACTOR = :contractor
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+
+        # @abstract
+        #
+        # The detailed employment status of the individual. Available options: `active`,
+        #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+        #
+        # @example
+        # ```ruby
+        # case employment_status
+        # in :active
+        #   # ...
+        # in :deceased
+        #   # ...
+        # in :leave
+        #   # ...
+        # in :onboarding
+        #   # ...
+        # in :prehire
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        class EmploymentStatus < FinchAPI::Enum
+          ACTIVE = :active
+          DECEASED = :deceased
+          LEAVE = :leave
+          ONBOARDING = :onboarding
+          PREHIRE = :prehire
+          RETIRED = :retired
+          TERMINATED = :terminated
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        class Manager < FinchAPI::BaseModel
+          # @!attribute [r] id
+          #   A stable Finch `id` (UUID v4) for an individual in the company.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :id
+
+          # @!parse
+          #   # The manager object representing the manager of the individual within the org.
+          #   #
+          #   # @param id [String]
+          #   #
+          #   def initialize(id: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

data/lib/finch-api/models/hris/employment_data_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class EmploymentDataResponse < FinchAPI::BaseModel
+        # @!attribute [r] body
+        #
+        #   @return [FinchAPI::Models::HRIS::EmploymentData, nil]
+        optional :body, -> { FinchAPI::Models::HRIS::EmploymentData }
+
+        # @!parse
+        #   # @return [FinchAPI::Models::HRIS::EmploymentData]
+        #   attr_writer :body
+
+        # @!attribute [r] code
+        #
+        #   @return [Integer, nil]
+        optional :code, Integer
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :code
+
+        # @!attribute [r] individual_id
+        #
+        #   @return [String, nil]
+        optional :individual_id, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :individual_id
+
+        # @!parse
+        #   # @param body [FinchAPI::Models::HRIS::EmploymentData]
+        #   # @param code [Integer]
+        #   # @param individual_id [String]
+        #   #
+        #   def initialize(body: nil, code: nil, individual_id: nil, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+      end
+    end
+  end
+end