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

data/lib/finch_api/models/hris/employment_data_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::Employments#retrieve_many
+      class EmploymentDataResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute body
+        #
+        #   @return [FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError]
+        required :body, union: -> { FinchAPI::HRIS::EmploymentData }
+
+        # @!attribute code
+        #
+        #   @return [Integer]
+        required :code, Integer
+
+        # @!attribute individual_id
+        #   A stable Finch `id` (UUID v4) for an individual in the company.
+        #
+        #   @return [String]
+        required :individual_id, String
+
+        # @!method initialize(body:, code:, individual_id:)
+        #   @param body [FinchAPI::HRIS::EmploymentData::UnionMember0, FinchAPI::HRIS::EmploymentData::BatchError]
+        #
+        #   @param code [Integer]
+        #
+        #   @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company.
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/employment_retrieve_many_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::Employments#retrieve_many
+      class EmploymentRetrieveManyParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute requests
+        #   The array of batch requests.
+        #
+        #   @return [Array<FinchAPI::HRIS::EmploymentRetrieveManyParams::Request>]
+        required :requests,
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request]
+                 }
+
+        # @!method initialize(requests:, request_options: {})
+        #   @param requests [Array<FinchAPI::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests.
+        #
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+        class Request < FinchAPI::Internal::Type::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
+
+          # @!method initialize(individual_id:)
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::HRIS::EmploymentRetrieveManyParams::Request} for more details.
+          #
+          #   @param individual_id [String] A stable Finch `id` (UUID v4) for an individual in the company. There is no limi
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/individual.rb

@@ -0,0 +1,256 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Individual
+        extend FinchAPI::Internal::Type::Union
+
+        variant -> { FinchAPI::HRIS::Individual::UnionMember0 }
+
+        variant -> { FinchAPI::HRIS::Individual::BatchError }
+
+        class UnionMember0 < FinchAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   A stable Finch `id` (UUID v4) for an individual in the company.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute dob
+          #
+          #   @return [String, nil]
+          required :dob, String, nil?: true
+
+          # @!attribute ethnicity
+          #   The EEOC-defined ethnicity of the individual.
+          #
+          #   @return [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Ethnicity, nil]
+          required :ethnicity, enum: -> { FinchAPI::HRIS::Individual::UnionMember0::Ethnicity }, nil?: true
+
+          # @!attribute first_name
+          #   The legal first name of the individual.
+          #
+          #   @return [String, nil]
+          required :first_name, String, nil?: true
+
+          # @!attribute gender
+          #   The gender of the individual.
+          #
+          #   @return [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Gender, nil]
+          required :gender, enum: -> { FinchAPI::HRIS::Individual::UnionMember0::Gender }, nil?: true
+
+          # @!attribute last_name
+          #   The legal last name of the individual.
+          #
+          #   @return [String, nil]
+          required :last_name, String, nil?: true
+
+          # @!attribute middle_name
+          #   The legal middle name of the individual.
+          #
+          #   @return [String, nil]
+          required :middle_name, String, nil?: true
+
+          # @!attribute phone_numbers
+          #
+          #   @return [Array<FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber, nil>, nil]
+          required :phone_numbers,
+                   -> {
+                     FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber,
+                                                       nil?: true]
+                   },
+                   nil?: true
+
+          # @!attribute preferred_name
+          #   The preferred name of the individual.
+          #
+          #   @return [String, nil]
+          required :preferred_name, String, nil?: true
+
+          # @!attribute residence
+          #
+          #   @return [FinchAPI::Location, nil]
+          required :residence, -> { FinchAPI::Location }, nil?: true
+
+          # @!attribute emails
+          #
+          #   @return [Array<FinchAPI::HRIS::Individual::UnionMember0::Email>, nil]
+          optional :emails,
+                   -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Individual::UnionMember0::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 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
+
+          # @!method initialize(id:, dob:, ethnicity:, first_name:, gender:, last_name:, middle_name:, phone_numbers:, preferred_name:, residence:, emails: nil, encrypted_ssn: nil, ssn: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::HRIS::Individual::UnionMember0} for more details.
+          #
+          #   @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
+          #
+          #   @param dob [String, nil]
+          #
+          #   @param ethnicity [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
+          #
+          #   @param first_name [String, nil] The legal first name of the individual.
+          #
+          #   @param gender [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Gender, nil] The gender of the individual.
+          #
+          #   @param last_name [String, nil] The legal last name of the individual.
+          #
+          #   @param middle_name [String, nil] The legal middle name of the individual.
+          #
+          #   @param phone_numbers [Array<FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber, nil>, nil]
+          #
+          #   @param preferred_name [String, nil] The preferred name of the individual.
+          #
+          #   @param residence [FinchAPI::Location, nil]
+          #
+          #   @param emails [Array<FinchAPI::HRIS::Individual::UnionMember0::Email>, nil]
+          #
+          #   @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
+          #
+          #   @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
+
+          # The EEOC-defined ethnicity of the individual.
+          #
+          # @see FinchAPI::HRIS::Individual::UnionMember0#ethnicity
+          module Ethnicity
+            extend FinchAPI::Internal::Type::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
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The gender of the individual.
+          #
+          # @see FinchAPI::HRIS::Individual::UnionMember0#gender
+          module Gender
+            extend FinchAPI::Internal::Type::Enum
+
+            FEMALE = :female
+            MALE = :male
+            OTHER = :other
+            DECLINE_TO_SPECIFY = :decline_to_specify
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          class PhoneNumber < FinchAPI::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [String, nil]
+            required :data, String, nil?: true
+
+            # @!attribute type
+            #
+            #   @return [Symbol, FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type, nil]
+            required :type,
+                     enum: -> {
+                       FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type
+                     },
+                     nil?: true
+
+            # @!method initialize(data:, type:)
+            #   @param data [String, nil]
+            #   @param type [Symbol, FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type, nil]
+
+            # @see FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber#type
+            module Type
+              extend FinchAPI::Internal::Type::Enum
+
+              WORK = :work
+              PERSONAL = :personal
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Email < FinchAPI::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [String]
+            required :data, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Email::Type, nil]
+            required :type, enum: -> { FinchAPI::HRIS::Individual::UnionMember0::Email::Type }, nil?: true
+
+            # @!method initialize(data:, type:)
+            #   @param data [String]
+            #   @param type [Symbol, FinchAPI::HRIS::Individual::UnionMember0::Email::Type, nil]
+
+            # @see FinchAPI::HRIS::Individual::UnionMember0::Email#type
+            module Type
+              extend FinchAPI::Internal::Type::Enum
+
+              WORK = :work
+              PERSONAL = :personal
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        class BatchError < FinchAPI::Internal::Type::BaseModel
+          # @!attribute code
+          #
+          #   @return [Float]
+          required :code, Float
+
+          # @!attribute message
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute finch_code
+          #
+          #   @return [String, nil]
+          optional :finch_code, String
+
+          # @!method initialize(code:, message:, name:, finch_code: nil)
+          #   @param code [Float]
+          #   @param message [String]
+          #   @param name [String]
+          #   @param finch_code [String]
+        end
+
+        # @!method self.variants
+        #   @return [Array(FinchAPI::HRIS::Individual::UnionMember0, FinchAPI::HRIS::Individual::BatchError)]
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/individual_in_directory.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::Directory#list
+      class IndividualInDirectory < FinchAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   A stable Finch `id` (UUID v4) for an individual in the company.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute department
+        #   The department object.
+        #
+        #   @return [FinchAPI::HRIS::IndividualInDirectory::Department, nil]
+        required :department, -> { FinchAPI::HRIS::IndividualInDirectory::Department }, nil?: true
+
+        # @!attribute first_name
+        #   The legal first name of the individual.
+        #
+        #   @return [String, nil]
+        required :first_name, String, nil?: true
+
+        # @!attribute is_active
+        #   `true` if the individual is an active employee or contractor at the company.
+        #
+        #   @return [Boolean, nil]
+        required :is_active, FinchAPI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute last_name
+        #   The legal last name of the individual.
+        #
+        #   @return [String, nil]
+        required :last_name, String, nil?: true
+
+        # @!attribute manager
+        #   The manager object.
+        #
+        #   @return [FinchAPI::HRIS::IndividualInDirectory::Manager, nil]
+        required :manager, -> { FinchAPI::HRIS::IndividualInDirectory::Manager }, nil?: true
+
+        # @!attribute middle_name
+        #   The legal middle name of the individual.
+        #
+        #   @return [String, nil]
+        required :middle_name, String, nil?: true
+
+        # @!method initialize(id:, department:, first_name:, is_active:, last_name:, manager:, middle_name:)
+        #   @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
+        #
+        #   @param department [FinchAPI::HRIS::IndividualInDirectory::Department, nil] The department object.
+        #
+        #   @param first_name [String, nil] The legal first name of the individual.
+        #
+        #   @param is_active [Boolean, nil] `true` if the individual is an active employee or contractor at the company.
+        #
+        #   @param last_name [String, nil] The legal last name of the individual.
+        #
+        #   @param manager [FinchAPI::HRIS::IndividualInDirectory::Manager, nil] The manager object.
+        #
+        #   @param middle_name [String, nil] The legal middle name of the individual.
+
+        # @see FinchAPI::HRIS::IndividualInDirectory#department
+        class Department < FinchAPI::Internal::Type::BaseModel
+          # @!attribute name
+          #   The name of the department.
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!method initialize(name: nil)
+          #   The department object.
+          #
+          #   @param name [String, nil] The name of the department.
+        end
+
+        # @see FinchAPI::HRIS::IndividualInDirectory#manager
+        class Manager < FinchAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   A stable Finch `id` (UUID v4) for an individual in the company.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   The manager object.
+          #
+          #   @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/individual_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::Individuals#retrieve_many
+      class IndividualResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute body
+        #
+        #   @return [FinchAPI::HRIS::Individual::UnionMember0, FinchAPI::HRIS::Individual::BatchError]
+        required :body, union: -> { FinchAPI::HRIS::Individual }
+
+        # @!attribute code
+        #
+        #   @return [Integer]
+        required :code, Integer
+
+        # @!attribute individual_id
+        #
+        #   @return [String]
+        required :individual_id, String
+
+        # @!method initialize(body:, code:, individual_id:)
+        #   @param body [FinchAPI::HRIS::Individual::UnionMember0, FinchAPI::HRIS::Individual::BatchError]
+        #   @param code [Integer]
+        #   @param individual_id [String]
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/individual_retrieve_many_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::Individuals#retrieve_many
+      class IndividualRetrieveManyParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute options
+        #
+        #   @return [FinchAPI::HRIS::IndividualRetrieveManyParams::Options, nil]
+        optional :options, -> { FinchAPI::HRIS::IndividualRetrieveManyParams::Options }, nil?: true
+
+        # @!attribute requests
+        #
+        #   @return [Array<FinchAPI::HRIS::IndividualRetrieveManyParams::Request>, nil]
+        optional :requests,
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
+                 }
+
+        # @!method initialize(options: nil, requests: nil, request_options: {})
+        #   @param options [FinchAPI::HRIS::IndividualRetrieveManyParams::Options, nil]
+        #   @param requests [Array<FinchAPI::HRIS::IndividualRetrieveManyParams::Request>]
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+        class Options < FinchAPI::Internal::Type::BaseModel
+          # @!attribute include
+          #
+          #   @return [Array<String>, nil]
+          optional :include, FinchAPI::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(include: nil)
+          #   @param include [Array<String>]
+        end
+
+        class Request < FinchAPI::Internal::Type::BaseModel
+          # @!attribute individual_id
+          #
+          #   @return [String, nil]
+          optional :individual_id, String
+
+          # @!method initialize(individual_id: nil)
+          #   @param individual_id [String]
+        end
+      end
+    end
+  end
+end