finch-api 0.1.0.pre.alpha.1

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class EmploymentRetrieveManyParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::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

@@ -0,0 +1,290 @@
+# 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
+
+          # @abstract
+          #
+          # @example
+          # ```ruby
+          # case type
+          # in :work
+          #   # ...
+          # in :personal
+          #   # ...
+          # end
+          # ```
+          class Type < FinchAPI::Enum
+            WORK = :work
+            PERSONAL = :personal
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+
+        # @abstract
+        #
+        # The EEOC-defined ethnicity of the individual.
+        #
+        # @example
+        # ```ruby
+        # case ethnicity
+        # in :asian
+        #   # ...
+        # in :white
+        #   # ...
+        # in :black_or_african_american
+        #   # ...
+        # in :native_hawaiian_or_pacific_islander
+        #   # ...
+        # in :american_indian_or_alaska_native
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        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
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        # @abstract
+        #
+        # The gender of the individual.
+        #
+        # @example
+        # ```ruby
+        # case gender
+        # in :female
+        #   # ...
+        # in :male
+        #   # ...
+        # in :other
+        #   # ...
+        # in :decline_to_specify
+        #   # ...
+        # end
+        # ```
+        class Gender < 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
+
+          # @abstract
+          #
+          # @example
+          # ```ruby
+          # case type
+          # in :work
+          #   # ...
+          # in :personal
+          #   # ...
+          # end
+          # ```
+          class Type < FinchAPI::Enum
+            WORK = :work
+            PERSONAL = :personal
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   #
+            #   def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class IndividualInDirectory < 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 department
+        #   The department object.
+        #
+        #   @return [FinchAPI::Models::HRIS::IndividualInDirectory::Department, nil]
+        optional :department, -> { FinchAPI::Models::HRIS::IndividualInDirectory::Department }, nil?: true
+
+        # @!attribute first_name
+        #   The legal first name of the individual.
+        #
+        #   @return [String, nil]
+        optional :first_name, String, nil?: true
+
+        # @!attribute is_active
+        #   `true` if the individual is 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 manager
+        #   The manager object.
+        #
+        #   @return [FinchAPI::Models::HRIS::IndividualInDirectory::Manager, nil]
+        optional :manager, -> { FinchAPI::Models::HRIS::IndividualInDirectory::Manager }, nil?: true
+
+        # @!attribute middle_name
+        #   The legal middle name of the individual.
+        #
+        #   @return [String, nil]
+        optional :middle_name, String, nil?: true
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param department [FinchAPI::Models::HRIS::IndividualInDirectory::Department, nil]
+        #   # @param first_name [String, nil]
+        #   # @param is_active [Boolean, nil]
+        #   # @param last_name [String, nil]
+        #   # @param manager [FinchAPI::Models::HRIS::IndividualInDirectory::Manager, nil]
+        #   # @param middle_name [String, nil]
+        #   #
+        #   def initialize(
+        #     id: nil,
+        #     department: nil,
+        #     first_name: nil,
+        #     is_active: nil,
+        #     last_name: nil,
+        #     manager: nil,
+        #     middle_name: nil,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        class Department < FinchAPI::BaseModel
+          # @!attribute name
+          #   The name of the department.
+          #
+          #   @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 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.
+          #   #
+          #   # @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/individual_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class IndividualResponse < FinchAPI::BaseModel
+        # @!attribute [r] body
+        #
+        #   @return [FinchAPI::Models::HRIS::Individual, nil]
+        optional :body, -> { FinchAPI::Models::HRIS::Individual }
+
+        # @!parse
+        #   # @return [FinchAPI::Models::HRIS::Individual]
+        #   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::Individual]
+        #   # @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/individual_retrieve_many_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class IndividualRetrieveManyParams < FinchAPI::BaseModel
+        # @!parse
+        #   extend FinchAPI::RequestParameters::Converter
+        include FinchAPI::RequestParameters
+
+        # @!attribute options
+        #
+        #   @return [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
+        optional :options, -> { FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options }, nil?: true
+
+        # @!attribute [r] requests
+        #
+        #   @return [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>, nil]
+        optional :requests,
+                 -> { FinchAPI::ArrayOf[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request] }
+
+        # @!parse
+        #   # @return [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>]
+        #   attr_writer :requests
+
+        # @!parse
+        #   # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
+        #   # @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>]
+        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(options: nil, requests: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | FinchAPI::BaseModel) -> void
+
+        class Options < FinchAPI::BaseModel
+          # @!attribute [r] include
+          #
+          #   @return [Array<String>, nil]
+          optional :include, FinchAPI::ArrayOf[String]
+
+          # @!parse
+          #   # @return [Array<String>]
+          #   attr_writer :include
+
+          # @!parse
+          #   # @param include [Array<String>]
+          #   #
+          #   def initialize(include: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+
+        class Request < FinchAPI::BaseModel
+          # @!attribute [r] individual_id
+          #
+          #   @return [String, nil]
+          optional :individual_id, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :individual_id
+
+          # @!parse
+          #   # @param individual_id [String]
+          #   #
+          #   def initialize(individual_id: nil, **) = super
+
+          # def initialize: (Hash | FinchAPI::BaseModel) -> void
+        end
+      end
+    end
+  end
+end