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

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

@@ -1,331 +0,0 @@
-# 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
-
-          # The secondary employment type of the individual. Options: `full_time`,
-          #   `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
-          module Subtype
-            extend 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
-
-          # The main employment type of the individual.
-          module Type
-            extend FinchAPI::Enum
-
-            EMPLOYEE = :employee
-            CONTRACTOR = :contractor
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-        end
-
-        # The detailed employment status of the individual. Available options: `active`,
-        #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
-        module EmploymentStatus
-          extend 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

@@ -1,45 +0,0 @@
-# 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

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

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class EmploymentRetrieveManyParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!attribute requests
-        #   The array of batch requests.
-        #
-        #   @return [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>]
-        required :requests,
-                 -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request] }
-
-        # @!parse
-        #   # @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>]
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(requests:, request_options: {}, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        class Request < FinchAPI::BaseModel
-          # @!attribute individual_id
-          #   A stable Finch `id` (UUID v4) for an individual in the company. There is no
-          #     limit to the number of `individual_id` to send per request. It is preferantial
-          #     to send all ids in a single request for Finch to optimize provider rate-limits.
-          #
-          #   @return [String]
-          required :individual_id, String
-
-          # @!parse
-          #   # @param individual_id [String]
-          #   #
-          #   def initialize(individual_id:, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-        end
-      end
-    end
-  end
-end

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

@@ -1,236 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module HRIS
-      class Individual < 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
-
-        # @!attribute dob
-        #
-        #   @return [String, nil]
-        optional :dob, String, nil?: true
-
-        # @!attribute emails
-        #
-        #   @return [Array<FinchAPI::Models::HRIS::Individual::Email>, nil]
-        optional :emails, -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::Individual::Email] }, nil?: true
-
-        # @!attribute encrypted_ssn
-        #   Social Security Number of the individual in **encrypted** format. This field is
-        #     only available with the `ssn` scope enabled and the
-        #     `options: { include: ['ssn'] }` param set in the body.
-        #
-        #   @return [String, nil]
-        optional :encrypted_ssn, String, nil?: true
-
-        # @!attribute ethnicity
-        #   The EEOC-defined ethnicity of the individual.
-        #
-        #   @return [Symbol, FinchAPI::Models::HRIS::Individual::Ethnicity, nil]
-        optional :ethnicity, enum: -> { FinchAPI::Models::HRIS::Individual::Ethnicity }, nil?: true
-
-        # @!attribute first_name
-        #   The legal first name of the individual.
-        #
-        #   @return [String, nil]
-        optional :first_name, String, nil?: true
-
-        # @!attribute gender
-        #   The gender of the individual.
-        #
-        #   @return [Symbol, FinchAPI::Models::HRIS::Individual::Gender, nil]
-        optional :gender, enum: -> { FinchAPI::Models::HRIS::Individual::Gender }, nil?: true
-
-        # @!attribute last_name
-        #   The legal last name of the individual.
-        #
-        #   @return [String, nil]
-        optional :last_name, String, nil?: true
-
-        # @!attribute middle_name
-        #   The legal middle name of the individual.
-        #
-        #   @return [String, nil]
-        optional :middle_name, String, nil?: true
-
-        # @!attribute phone_numbers
-        #
-        #   @return [Array<FinchAPI::Models::HRIS::Individual::PhoneNumber, nil>, nil]
-        optional :phone_numbers,
-                 -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::Individual::PhoneNumber, nil?: true] },
-                 nil?: true
-
-        # @!attribute preferred_name
-        #   The preferred name of the individual.
-        #
-        #   @return [String, nil]
-        optional :preferred_name, String, nil?: true
-
-        # @!attribute residence
-        #
-        #   @return [FinchAPI::Models::Location, nil]
-        optional :residence, -> { FinchAPI::Models::Location }, nil?: true
-
-        # @!attribute ssn
-        #   Social Security Number of the individual. This field is only available with the
-        #     `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
-        #     body.
-        #     [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
-        #
-        #   @return [String, nil]
-        optional :ssn, String, nil?: true
-
-        # @!parse
-        #   # @param id [String]
-        #   # @param dob [String, nil]
-        #   # @param emails [Array<FinchAPI::Models::HRIS::Individual::Email>, nil]
-        #   # @param encrypted_ssn [String, nil]
-        #   # @param ethnicity [Symbol, FinchAPI::Models::HRIS::Individual::Ethnicity, nil]
-        #   # @param first_name [String, nil]
-        #   # @param gender [Symbol, FinchAPI::Models::HRIS::Individual::Gender, nil]
-        #   # @param last_name [String, nil]
-        #   # @param middle_name [String, nil]
-        #   # @param phone_numbers [Array<FinchAPI::Models::HRIS::Individual::PhoneNumber, nil>, nil]
-        #   # @param preferred_name [String, nil]
-        #   # @param residence [FinchAPI::Models::Location, nil]
-        #   # @param ssn [String, nil]
-        #   #
-        #   def initialize(
-        #     id: nil,
-        #     dob: nil,
-        #     emails: nil,
-        #     encrypted_ssn: nil,
-        #     ethnicity: nil,
-        #     first_name: nil,
-        #     gender: nil,
-        #     last_name: nil,
-        #     middle_name: nil,
-        #     phone_numbers: nil,
-        #     preferred_name: nil,
-        #     residence: nil,
-        #     ssn: nil,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        class Email < FinchAPI::BaseModel
-          # @!attribute [r] data
-          #
-          #   @return [String, nil]
-          optional :data, String
-
-          # @!parse
-          #   # @return [String]
-          #   attr_writer :data
-
-          # @!attribute type
-          #
-          #   @return [Symbol, FinchAPI::Models::HRIS::Individual::Email::Type, nil]
-          optional :type, enum: -> { FinchAPI::Models::HRIS::Individual::Email::Type }, nil?: true
-
-          # @!parse
-          #   # @param data [String]
-          #   # @param type [Symbol, FinchAPI::Models::HRIS::Individual::Email::Type, nil]
-          #   #
-          #   def initialize(data: nil, type: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          module Type
-            extend FinchAPI::Enum
-
-            WORK = :work
-            PERSONAL = :personal
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-        end
-
-        # The EEOC-defined ethnicity of the individual.
-        module Ethnicity
-          extend 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
-
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
-        end
-
-        # The gender of the individual.
-        module Gender
-          extend FinchAPI::Enum
-
-          FEMALE = :female
-          MALE = :male
-          OTHER = :other
-          DECLINE_TO_SPECIFY = :decline_to_specify
-
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
-        end
-
-        class PhoneNumber < FinchAPI::BaseModel
-          # @!attribute data
-          #
-          #   @return [String, nil]
-          optional :data, String, nil?: true
-
-          # @!attribute type
-          #
-          #   @return [Symbol, FinchAPI::Models::HRIS::Individual::PhoneNumber::Type, nil]
-          optional :type, enum: -> { FinchAPI::Models::HRIS::Individual::PhoneNumber::Type }, nil?: true
-
-          # @!parse
-          #   # @param data [String, nil]
-          #   # @param type [Symbol, FinchAPI::Models::HRIS::Individual::PhoneNumber::Type, nil]
-          #   #
-          #   def initialize(data: nil, type: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          module Type
-            extend FinchAPI::Enum
-
-            WORK = :work
-            PERSONAL = :personal
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-        end
-      end
-    end
-  end
-end